Skip to main content
GET
Listar assinaturas
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.
A listagem não traz os itens. Cada linha é a assinatura — estado, cliente, datas do ciclo —, sem items. Para saber o que ela cobra, use GET /subscriptions/{id}.
dateFrom e dateTo não fazem nada sozinhos. Eles filtram o campo escolhido em dateFieldstarted, 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.
Para achar por cliente, você precisa do 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.
Estados terminais continuam na listagem. Sem filtro, canceled, completed e incomplete_expired vêm junto com as ativas. Para o que está cobrando hoje, filtre ?status=active,trialing,past_due.

Exemplo

Resposta 200

Authorizations

x-api-key
string
header
required

API Key da Credential (gerada no Backoffice)

Query Parameters

page
integer
default:1

Página da listagem. Padrão: 1.

Required range: x >= 1
limit
integer
default:20

Itens por página. Padrão: 20. Máximo: 100.

Required range: 1 <= x <= 100
status
enum<string>[]

Situaçã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.

Available options:
incomplete,
incomplete_expired,
pending_enrollment,
trialing,
active,
past_due,
unpaid,
paused,
canceled,
completed
code
string

Número da assinatura, como aparece no painel (2026-0042). Correspondência parcial: 42 encontra 2026-0042. Um valor por requisição.

Maximum string length: 20
paymentMethods
enum<string>[]

Forma de pagamento padrão da assinatura. Aceita vários valores, separados por vírgula ou repetindo o parâmetro.

Available options:
card,
pix,
boleto,
other
planIds
string[]

Assinaturas que cobram algum componente destes planos. Aceita vários ids, separados por vírgula ou repetindo o parâmetro.

Maximum string length: 36
dateField
enum<string>

Qual 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.

Available options:
started,
ended,
next_invoice
dateFrom

Início do período, em ISO 8601. Exige dateField.

dateTo

Fim do período, em ISO 8601. Exige dateField.

customerId
string

Assinaturas de um cliente (cust_). Correspondência exata.

referenceCode
string

O código que você gravou na criação da assinatura. Correspondência exata — é o caminho para reencontrar pelo seu próprio identificador.

Maximum string length: 255
sortBy
enum<string>

Campo de ordenação: code, startedAt ou nextInvoiceAt. Default: startedAt.

Available options:
code,
startedAt,
nextInvoiceAt
sortDir
enum<string>

Direção da ordenação: asc ou desc. Default: desc.

Available options:
asc,
desc

Response

Lista paginada

data
object[]

Lista de registros retornados na página atual.

pagination
object

Dados de paginação do resultado.