Listar assinaturas

GET/api/v1/subscriptions/

Parâmetro	Descrição
status	Status da assinatura — ver Referência de status
externalReference	Sua referência, correspondência exata
search	Busca parcial, sem diferenciar maiúsculas, em nome do pagador, descrição e externalReference
cycle	Ciclo de cobrança — ver Referência de status
lastChargeStatus	Resultado da última cobrança: CONFIRMED, DENIED, REFUNDED ou o código numérico
minConsecutiveDenied	Só assinaturas com pelo menos N cobranças negadas seguidas. Inteiro >= 1
startDate	Data inicial de criação, YYYY-MM-DD
endDate	Data final de criação, YYYY-MM-DD. Inclusivo
page	Número da página. Padrão 1
pageSize	Itens por página. Padrão 50, máximo 200

Achar inadimplentes

?status=0&lastChargeStatus=DENIED lista as assinaturas ativas cuja última cobrança foi negada. ?minConsecutiveDenied=2 lista as que acumulam duas ou mais negações seguidas.

Resposta 200

{
  "status": "success",
  "data": [
    { "id": 12, "status": 0, "lastChargeStatus": "DENIED", "consecutiveDeniedCharges": 2, "...": "..." }
  ],
  "filters": {
    "status": 0,
    "lastChargeStatus": 2,
    "minConsecutiveDenied": null,
    "externalReference": "",
    "startDate": "",
    "endDate": ""
  },
  "pagination": { "page": 1, "pageSize": 50, "total": 13, "totalPages": 1 }
}

Em filters, lastChargeStatus é ecoado no formato numérico (2 = DENIED), mesmo quando enviado como texto.

Campos de inadimplência da assinatura — presentes na listagem, no detalhe e em todas as respostas que devolvem a assinatura.

Campo	Valores	Descrição
lastChargeStatus	"CONFIRMED", "DENIED", "REFUNDED" ou null	Resultado da tentativa de cobrança mais recente, inclusive retentativas. null enquanto não houve cobrança
lastChargeAt	ISO 8601 ou null	Data e hora dessa tentativa. Atualiza também a cada retentativa
consecutiveDeniedCharges	inteiro >= 0	Quantas cobranças seguidas foram negadas. Zera quando uma cobrança é confirmada. Retentativas da mesma cobrança não somam. Estorno não altera

aviso

A assinatura não muda de status sozinha por inadimplência: segue ACTIVE mesmo com cobranças negadas. A decisão de suspender ou cancelar é sua — use os campos acima e POST /cancel (Cancelar assinatura).