Skip to main content
GET
GET /subscription devolve uma lista paginada das suas assinaturas. Filtre por status, e-mail ou nome do cliente, plano, bandeira do cartão ou intervalo de data de criação para restringir os resultados. Os resultados são devolvidos em ordem cronológica inversa por data de criação. Filtre e pagine com os parâmetros de consulta do painel acima (created_from/created_to são limites de data ISO 8601 inclusivos sobre createdAt). Formato da resposta:
Combine created_from e created_to com status=past_due para identificar os assinantes que ficaram inadimplentes dentro de uma janela específica — útil para campanhas de recuperação direcionadas.

Autorizações

​
Authorization
string
header
obrigatório

Your secret API key: Bearer prv_production_xxx (production) or Bearer prv_sandbox_xxx (sandbox).

Parâmetros de consulta

​
merchantCode
string
obrigatório

Your merchant account identifier.

​
status
string

Filter by status: pending, trialing, active, past_due, suspended, cancelled, paused, completed.

​
email
string

Partial, case-insensitive match on customer email.

​
customer_name
string

Partial, case-insensitive match on customer name.

​
plan_id
string

Filter to one plan ID.

​
card_brand
string

Filter by card brand, e.g. visa, mastercard, amex.

​
created_from
string

ISO 8601 date lower bound (inclusive) on creation date.

​
created_to
string

ISO 8601 date upper bound (inclusive) on creation date.

​
page
integer

Page number, starting at 1. Default 1.

​
per_page
integer

Results per page. Default 20, max 200.

Resposta

200 - application/json

List of subscriptions

​
data
object[]
​
total
integer

Total subscriptions matching the filters, across all pages.

​
page
integer

Current page number.

​
per_page
integer

Page size applied.