Consultar assinatura

Devolve uma assinatura pelo id: status, meio de pagamento, próximo vencimento e cliente (documento mascarado).

Status

statusSignificaÉ cobrada?
PENDING_ENROLLMENTCriada, aguardando a adesão do cartãoNão
ACTIVEEm diaSim, a cada vencimento
PAST_DUEUma fatura esgotou as 3 tentativasNão cobra períodos novos até a fatura em atraso ser resolvida
SUSPENDEDPausada pelo estabelecimentoNão
CANCELEDEncerrada (definitivo)Não

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