Listar assinaturas

Lista as assinaturas cadastradas na conta conforme os filtros informados.

Use esta operação para localizar conjuntos de assinaturas ou realizar consultas e conciliações. A resposta segue o padrão de listagem e paginação da API.

deletedOnly e includeDeleted possuem comportamentos diferentes: utilize deletedOnly para retornar somente assinaturas removidas e includeDeleted para incluir assinaturas removidas na listagem geral.

Quando customer não corresponder a um cliente existente na conta autenticada, a consulta retorna uma lista vazia em vez de um erro de recurso não encontrado.

📘

Acompanhamento de mudanças

Para acompanhar criação, atualização, inativação ou remoção de assinaturas, utilize Webhooks em vez de consultar este endpoint repetidamente.

Use este GET para consultas pontuais, recuperação ou conciliação.

Consulte os eventos de Webhook para assinaturas.

Conteúdos relacionados

Guides

Query Params
integer

Elemento inicial da lista

integer
≤ 100

Número de elementos da lista (max: 100)

string

Filtrar pelo Identificador único do cliente

string

Filtrar pelo nome do grupo de cliente

string
enum

Filtrar por forma de pagamento

Allowed:
string
enum

Filtrar pelo status

Allowed:
string

Envie true para retornar somente as assinaturas removidas

string

Envie true para recuperar também as assinaturas removidas

string

Filtrar pelo Identificador do seu sistema

string

Ordem crescente ou decrescente

string

Por qual campo será ordenado

Responses

403

Forbidden. Ocorre quando o body da requisição está preenchido, chamadas de método GET precisam ter um body vazio.

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json