Referência da API

Listar assinaturas

Lista paginada de Subscriptions da sua conta, ordenadas por `createdAt DESC`. Cada item inclui Customer resumido e Offer (com Product). Valores em centavos.

GET/v2/subscriptions

Paginação 0-indexed

page `page=0` é a primeira página. Default: 0.

Autenticação

HTTP Basic Auth. Envie sua secret key no header:

Authorization: Basic {base64(secret:SUA_SECRET_KEY)}

Parâmetros

Filtra por status específico.

Exemplo: ACTIVE

customerIdstring (query, UUID)opcional

Filtra assinaturas de um Customer específico.

Exemplo: c8a5f4d2-...

offerIdstring (query, UUID)opcional

Filtra assinaturas baseadas em uma Offer específica.

Exemplo: off_xyz789

pagenumber (query, 0-indexed)opcional

Página, começando em 0. Padrão: 0.

Exemplo: 0

limitnumber (query)opcional

Por página. Default: 20. Máximo: 100.

Exemplo: 20

Respostas

200

Lista paginada de Subscriptions.

JSON

{
  "result": [
    {
      "id": "sub_abc123-...",
      "status": "ACTIVE",
      "amount": 4900,
      "billingCycle": "MONTHLY",
      "billingCycleCount": 1,
      "currentCycle": 3,
      "maxCycles": 12,
      "nextBillingAt": "2026-09-01T00:00:00.000Z",
      "startedAt": "2026-06-01T00:00:00.000Z",
      "expiresAt": null,
      "canceledAt": null,
      "createdAt": "2026-05-26T14:32:01.923Z",
      "customer": {
        "id": "c8a5f4d2-...",
        "name": "João Silva",
        "document": "12345678901",
        "email": "joao@exemplo.com"
      },
      "offer": {
        "id": "off_xyz789",
        "name": "Mensal",
        "product": { "id": "prd_111", "name": "Plano Pro" }
      }
    }
  ],
  "totalCount": 47
}

Exemplos

cURL

# Apenas ativas
curl -X GET "https://api.pagnovo.com/v2/subscriptions?status=ACTIVE&limit=50" \
  -H "Authorization: Basic $(echo -n 'secret:SUA_SECRET_KEY' | base64)"

# De um cliente específico
curl -X GET "https://api.pagnovo.com/v2/subscriptions?customerId=c8a5f4d2-..." \
  -H "Authorization: Basic $(echo -n 'secret:SUA_SECRET_KEY' | base64)"