Visão consolidada de cobranças

Duas rotas para acompanhar a carteira inteira e conciliar, sem consultar assinatura por assinatura.

Resumo do mês

GET/api/v1/subscriptions/overview

{
  "data": {
    "active": 128,
    "pendingActivation": 7,
    "confirmedValue": 382720,
    "deniedCount": 11
  },
  "period": { "startDate": "2026-10-01", "endDate": "2026-10-31" }
}

Campo	Descrição
active	Assinaturas ACTIVE
pendingActivation	Assinaturas PENDING_PAYMENT
confirmedValue	Soma, em centavos, das cobranças confirmadas com vencimento no mês
deniedCount	Cobranças negadas com vencimento no mês
period	Mês corrente no horário de Brasília. Não aceita filtro

Todas as cobranças do lojista

GET/api/v1/subscriptions/charges

Parâmetro	Descrição
status	0 PENDING · 1 CONFIRMED · 2 DENIED · 3 REFUNDED
subscriptionId	Só as cobranças de uma assinatura
search	Busca parcial em nome do pagador, descrição ou externalReference da assinatura
startDate	Vencimento inicial, YYYY-MM-DD
endDate	Vencimento final, YYYY-MM-DD. Inclusivo
page	Número da página. Padrão 1
pageSize	Itens por página. Padrão 25, máximo 200

{
  "data": [
    {
      "id": 791,
      "subscriptionId": 12,
      "payerName": "Joao da Silva",
      "description": "Plano Premium",
      "status": 2,
      "value": 2990,
      "dueDate": "2026-10-09",
      "denialCode": "05",
      "denialMessage": "Not Authorized",
      "attempts": 1,
      "nextRetryAt": "2026-10-10"
    }
  ],
  "pagination": { "page": 1, "pageSize": 25, "total": 120, "totalPages": 5 }
}

Ordenada do vencimento mais recente para o mais antigo. Filtro inválido devolve 400 Filtros de cobrança inválidos. Estas duas rotas não trazem "status": "success" no corpo — leia data direto.

Conciliação recomendada

Use os webhooks (Webhooks de cobrança) como gatilho e esta rota como fonte de verdade — por exemplo, uma consulta diária de ?startDate=<ontem>&endDate=<hoje> para confirmar que nenhum evento se perdeu.