Skip to main content

​
Visão geral

Este endpoint retorna uma lista paginada de todas as assinaturas criadas na sua conta, com suporte a filtros por status, cliente e período.

​
Endpoint

curl --request GET \
  --url "https://api.avanttifinance.com/v1/subscriptions?status=active&page=1&limit=20" \
  --header "Authorization: Bearer SEU_TOKEN_DE_ACESSO"

​
Parâmetros de consulta

​
status
string
Filtra pelo status da assinatura: active, paused, canceled ou past_due.
​
customer_id
string
Filtra as assinaturas de um cliente específico.
​
page
integer
default:"1"
Número da página de resultados.
​
limit
integer
default:"20"
Quantidade de itens por página. Máximo de 100.

​
Resposta

​
data
array
Lista de objetos de assinatura.
​
pagination
object
Informações de paginação, incluindo página atual, total de páginas e total de registros.

​
Exemplo de resposta

{
  "data": [
    {
      "id": "sub_7c4a1f2e9b",
      "customer_id": "cus_3a8f9c1b2d",
      "plan": "Plano Premium - Mensal",
      "amount": 9990,
      "status": "active",
      "next_billing_date": "2026-07-10",
      "created_at": "2026-01-10T10:00:00Z"
    },
    {
      "id": "sub_2b3c4d5e6f",
      "customer_id": "cus_8e7d6c5b4a",
      "plan": "Plano Básico - Anual",
      "amount": 59900,
      "status": "past_due",
      "next_billing_date": "2026-06-05",
      "created_at": "2025-06-05T08:30:00Z"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total_pages": 3,
    "total_items": 52
  }
}
Use o filtro status=past_due para identificar assinaturas com pagamento em atraso e acionar fluxos de cobrança.

​
Próximos passos

Criar assinatura

Crie uma nova assinatura recorrente.

Cancelar assinatura

Cancele uma assinatura existente.