Listar assinaturas
Lista paginada das assinaturas da conta, com filtros por estado, cliente, plano, forma de pagamento e data.
GET /subscriptions
Faz parte do recurso Assinaturas — o conceito e os dez estados estão lá.
Devolve as assinaturas da sua conta em páginas de 20 por padrão, da mais recente para a mais antiga.
Os filtros são opcionais e se somam: quem envia mais de um recebe só as assinaturas que atendem a
todos.
dateFrom e dateTo não fazem nada sozinhos. Eles filtram o campo escolhido em dateField
— started, ended ou next_invoice. Sem dateField, o intervalo não tem sobre o que incidir.É o filtro que responde as perguntas de operação: next_invoice entre hoje e amanhã lista o que
vai ser cobrado. Para achar quem está devendo, liste as faturas com
GET /invoices?status=past_due — o vencimento é dado da
fatura, não da assinatura.cust_. O filtro customerId é correspondência
exata, e não há busca por nome ou e-mail aqui — use
GET /customers para achar o cliente e filtre por ID.canceled, completed e
incomplete_expired vêm junto com as ativas. Para o que está cobrando hoje, filtre
?status=active,trialing,past_due.Exemplo
Authorizations
API Key da Credential (gerada no Backoffice)
Query Parameters
Página da listagem. Padrão: 1.
x >= 1Itens por página. Padrão: 20. Máximo: 100.
1 <= x <= 100Situação da assinatura. Aceita vários valores, separados por vírgula ou repetindo o parâmetro. Um valor inválido responde 400 com a lista dos aceitos.
incomplete, incomplete_expired, pending_enrollment, trialing, active, past_due, unpaid, paused, canceled, completed Número da assinatura, como aparece no painel (2026-0042). Correspondência parcial: 42 encontra 2026-0042. Um valor por requisição.
20Forma de pagamento padrão da assinatura. Aceita vários valores, separados por vírgula ou repetindo o parâmetro.
card, pix, boleto, other Assinaturas que cobram algum componente destes planos. Aceita vários ids, separados por vírgula ou repetindo o parâmetro.
36Qual data o período dateFrom/dateTo filtra: started (início), ended (encerramento) ou next_invoice (próxima fatura). Sem ele, o período não é aplicado.
started, ended, next_invoice Início do período, em ISO 8601. Exige dateField.
Fim do período, em ISO 8601. Exige dateField.
Assinaturas de um cliente (cust_). Correspondência exata.
O código que você gravou na criação da assinatura. Correspondência exata — é o caminho para reencontrar pelo seu próprio identificador.
255Campo de ordenação: code, startedAt ou nextInvoiceAt. Default: startedAt.
code, startedAt, nextInvoiceAt Direção da ordenação: asc ou desc. Default: desc.
asc, desc