Listar faturas da assinatura

Lista as faturas da assinatura, da mais recente para a mais antiga (até 200).

Ciclo de uma fatura

statusSignifica
SCHEDULEDCriada 3 dias antes do vencimento; aguarda o dia
OPENCobrança em andamento
PAIDPaga; paymentId aponta para o pagamento em GET /v1/acquiring/payments/{paymentId}
RETRYINGRecusada; nova tentativa em nextAttemptAt, motivo em lastFailureCode/lastFailureReason. Sem nextAttemptAt: resultado em conciliação, a Autra não repete sozinha
OVERDUEEsgotou as 3 tentativas; a assinatura fica PAST_DUE
CANCELEDCancelada junto com a assinatura

lastFailureCode traz o código de resposta do emissor (ABECS, ex.: 51 saldo insuficiente, 05 não autorizada, 54 cartão vencido) ou do adquirente; lastFailureReason é o texto para mostrar ao cliente.

Erros — corpo {"errors":[{"code":"...","msg":"..."}]}; msg detalha o campo quando é validação:

codeHTTPQuando aconteceO que fazer
MISSING_DOCUMENT_ID400Estabelecimento não informado.Envie o header X-Merchant-Document (ou documentId).
TENANT_REQUIRED400A credencial não identifica o tenant.Gere o token com as credenciais do seu tenant (POST /v1/oauth/token).
FEATURE_DISABLED403O módulo de assinaturas não está habilitado para o tenant.Peça a habilitação à Autra.
MERCHANT_NOT_FOUND404O documento não é de um estabelecimento do seu tenant.Confira o CPF/CNPJ do estabelecimento.
SUBSCRIPTION_NOT_FOUND404Assinatura não existe neste estabelecimento.Confira o id.
INVALID_DOCUMENT422Documento do estabelecimento malformado.CPF com 11 ou CNPJ com 14 dígitos, só números.
INTERNAL_ERROR500Falha interna.Tente de novo; persistindo, fale com o suporte com o horário da chamada.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
uuid
required

ID da assinatura (UUID)

Query Params
string

CPF/CNPJ do estabelecimento, quando não usar o header

Headers
string

CPF/CNPJ do estabelecimento (só números). Preferido; alternativa: documentId na query

Responses

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json