Endpoint responsável por listar assinaturas cadastradas na conta Asaas de acordo com os filtros informados.
Diferente da recuperação de uma assinatura específica, este endpoint retorna uma lista paginada de assinaturas, permitindo consultar assinaturas por cliente, forma de pagamento, status, referência externa, grupo de clientes ou situação de remoção.
Esse recurso é indicado para integrações que precisam consultar assinaturas em lote, sincronizar dados com sistemas externos, alimentar rotinas de conciliação, montar telas administrativas ou localizar assinaturas antes de realizar ações como consulta individual, atualização ou cancelamento.
Guia de AssinaturasPara entender o funcionamento completo de assinaturas, recorrência, criação de cobranças e ciclo de vida do recurso, consulte o guia de Assinaturas.
Quando utilizar
Utilize este endpoint quando sua integração precisar:
- listar assinaturas cadastradas na conta;
- consultar todas as assinaturas de um cliente específico;
- filtrar assinaturas por forma de pagamento;
- localizar assinaturas ativas, inativas ou expiradas;
- buscar assinaturas vinculadas a uma referência do seu sistema;
- sincronizar assinaturas com ERPs, CRMs, dashboards ou sistemas internos;
- recuperar assinaturas removidas, quando necessário.
Para consultar os dados de uma única assinatura, utilize o endpoint de recuperação individual informando o identificador da assinatura.
Paginação
A listagem de assinaturas é paginada.
Use os parâmetros limit e offset para controlar a quantidade de registros retornados e a posição inicial da consulta.
| Parâmetro | Finalidade |
|---|---|
limit | Define a quantidade máxima de registros retornados na requisição. O valor máximo permitido é 100. |
offset | Define a partir de qual posição a listagem deve iniciar. |
Exemplo de primeira página:
GET https://api.asaas.com/v3/subscriptions?limit=100&offset=0Exemplo de próxima página:
GET https://api.asaas.com/v3/subscriptions?limit=100&offset=100Para percorrer todos os resultados, incremente o offset de acordo com o limit utilizado até que não existam mais registros a serem retornados.
RecomendadoEm integrações com grande volume de assinaturas, utilize paginação com
limit=100e processe os dados em lotes, evitando consultas repetitivas ou desnecessárias.
Filtros disponíveis
Os filtros podem ser utilizados para restringir o retorno da listagem.
| Filtro | Finalidade |
|---|---|
customer | Filtra assinaturas vinculadas a um cliente específico. Deve ser informado o identificador único do cliente no Asaas. |
customerGroupName | Filtra assinaturas de clientes pertencentes a um determinado grupo. |
billingType | Filtra assinaturas pela forma de pagamento. |
status | Filtra assinaturas pelo status atual. |
deletedOnly | Quando enviado como true, retorna somente assinaturas removidas. |
includeDeleted | Quando enviado como true, inclui assinaturas removidas no retorno. |
externalReference | Filtra assinaturas pelo identificador enviado pela sua integração. |
sort | Define o campo utilizado para ordenação. |
order | Define se a ordenação será crescente ou decrescente. |
Os filtros podem ser combinados para tornar a consulta mais específica.
Exemplo:
GET https://api.asaas.com/v3/subscriptions?customer={customer_id}&billingType=CREDIT_CARD&status=ACTIVE
AtençãoQuando utilizar o filtro
customer, informe um cliente existente e pertencente à conta autenticada pela API Key. Caso o identificador não exista ou não pertença à conta, nenhuma assinatura será retornada para esse filtro.
Formas de pagamento
O filtro billingType permite listar assinaturas de acordo com a forma de pagamento configurada.
Valores aceitos:
UNDEFINEDBOLETOCREDIT_CARDDEBIT_CARDTRANSFERDEPOSITPIX
Exemplo:
GET https://api.asaas.com/v3/subscriptions?billingType=CREDIT_CARDUse esse filtro quando sua integração precisar separar assinaturas por meio de pagamento, como assinaturas em cartão de crédito, Pix ou boleto.
Status da assinatura
O filtro status permite listar assinaturas conforme sua situação atual.
Valores aceitos:
ACTIVEEXPIREDINACTIVE
Exemplo:
GET https://api.asaas.com/v3/subscriptions?status=ACTIVEEsse filtro é útil para rotinas que precisam considerar apenas assinaturas ativas ou identificar assinaturas encerradas/inativas para atualização em sistemas externos.
Consulta por cliente
Para listar assinaturas de um cliente específico, utilize o parâmetro customer com o identificador único do cliente no Asaas.
GET https://api.asaas.com/v3/subscriptions?customer={customer_id}Esse filtro é indicado para telas de detalhe do cliente, rotinas de conciliação por pagador ou verificações antes de criar uma nova assinatura.
Boas práticasArmazene o identificador do cliente retornado pelo Asaas no momento da criação do cadastro. Embora seja possível buscar clientes por outros dados, o ID do cliente é a forma mais segura de relacionar assinaturas ao pagador correto.
Consulta por referência externa
Caso sua integração envie o campo externalReference na criação da assinatura, ele pode ser utilizado posteriormente para localizar registros vinculados ao identificador do seu sistema.
GET https://api.asaas.com/v3/subscriptions?externalReference={referencia_interna}Esse filtro é recomendado para integrações que precisam conciliar dados entre o Asaas e sistemas próprios, como ERPs, CRMs ou plataformas SaaS.
Assinaturas removidas
Por padrão, a listagem pode não considerar assinaturas removidas conforme o filtro utilizado.
Para consultar somente assinaturas removidas, utilize:
GET https://api.asaas.com/v3/subscriptions?deletedOnly=truePara incluir assinaturas removidas junto às demais, utilize:
GET https://api.asaas.com/v3/subscriptions?includeDeleted=true
AtençãoUtilize
deletedOnlyquando a intenção for retornar apenas registros removidos. UtilizeincludeDeletedquando a intenção for manter a listagem geral e também incluir assinaturas removidas no resultado.
Comportamentos importantes
Ao utilizar este endpoint, considere que:
- a listagem retorna apenas assinaturas da conta autenticada pela API Key;
- chamadas sem filtros retornam uma listagem paginada das assinaturas da conta;
- filtros podem ser combinados para reduzir o volume de dados retornados;
- o retorno pode ser vazio caso nenhum registro corresponda aos filtros informados;
- assinaturas removidas dependem do uso de
deletedOnlyouincludeDeleted; - consultas com grande volume devem utilizar paginação;
- chamadas
GETdevem ser enviadas sem body.
AtençãoRequisições
GETcom body preenchido podem retornar erro403. Envie os filtros sempre como query params na URL.
Exemplos de uso
Listar assinaturas de um cliente específico:
GET https://api.asaas.com/v3/subscriptions?customer={customer_id}Filtrar assinaturas por forma de pagamento:
GET https://api.asaas.com/v3/subscriptions?billingType=CREDIT_CARDListar assinaturas ativas em cartão de crédito:
GET https://api.asaas.com/v3/subscriptions?billingType=CREDIT_CARD&status=ACTIVEListar assinaturas com paginação:
GET https://api.asaas.com/v3/subscriptions?limit=100&offset=0Listar assinaturas por referência externa:
GET https://api.asaas.com/v3/subscriptions?externalReference={referencia_interna}Boas práticas
- Utilize filtros sempre que possível para reduzir o volume retornado.
- Utilize paginação em consultas recorrentes ou com grande volume.
- Armazene o ID da assinatura retornado pelo Asaas para consultas futuras.
- Armazene o ID do cliente para evitar buscas imprecisas.
- Utilize
externalReferencepara conciliar dados com o seu sistema. - Trate respostas vazias como um cenário esperado.
- Não envie body em requisições
GET. - Evite executar listagens completas com alta frequência quando filtros mais específicos puderem ser utilizados.
Erros comuns
400 Bad Request
400 Bad RequestPode ocorrer quando algum filtro é enviado com valor inválido, como um billingType ou status não aceito.
401 Unauthorized
401 UnauthorizedOcorre quando a API Key não foi informada, está inválida ou não corresponde ao ambiente utilizado.
403 Forbidden
403 ForbiddenPode ocorrer quando a requisição GET é enviada com body preenchido. Chamadas de listagem devem utilizar apenas query params.
Retorno vazio
Pode ocorrer quando não existem assinaturas para os filtros informados, quando o cliente informado não possui assinaturas ou quando o identificador enviado não pertence à conta autenticada.
Impactos operacionais
Listagens de assinaturas podem envolver grande volume de dados, especialmente em contas com muitas recorrências ativas.
Para evitar lentidão, consumo desnecessário de limite de API ou processamento excessivo na aplicação, recomenda-se:
- consultar por cliente quando possível;
- utilizar filtros de status, forma de pagamento ou referência externa;
- processar resultados paginados em lotes;
- evitar sincronizações completas em intervalos muito curtos;
- armazenar localmente os identificadores retornados pela API.
Conteúdos relacionados
- Criar assinatura
- Recuperar uma única assinatura
- Atualizar assinatura
- Remover assinatura
- Criar cliente
- Listar clientes
- Autenticação da API
- Paginação
- Limites da API
- Webhooks de cobrança e Webhooks de assinatura.
403Forbidden. Ocorre quando o body da requisição está preenchido, chamadas de método GET precisam ter um body vazio.
