Suspender assinatura

Pausa a cobrança: enquanto SUSPENDED, a assinatura não gera faturas novas nem inicia cobranças. Só de ACTIVE ou PAST_DUE. Webhook subscription.suspended. Para voltar a cobrar, use reativar.

Atenção: uma cobrança já em andamento (fatura OPEN) no momento da suspensão termina normalmente e pode ser debitada.

Corpo opcional com reason (até 500 caracteres).

Transições

AçãoDePara
cancelarqualquer status exceto CANCELEDCANCELED
suspenderACTIVE, PAST_DUESUSPENDED
reativarSUSPENDEDACTIVE

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

codeHTTPQuando aconteceO que fazer
INVALID_INPUT400Campo inválido ou fora do limite; msg diz qual e a regra.Corrija o campo indicado.
INVALID_JSON400Corpo não é um objeto JSON válido.Corrija o JSON.
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_STATUS_TRANSITION409O status atual não permite a ação (ou mudou durante a chamada).Consulte a assinatura e veja a tabela de transições.
PAYLOAD_TOO_LARGE413Corpo acima de 64 KiB.Reduza o corpo da requisição.
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 nem o corpo

Body Params

Motivo (opcional)

string

Documento do estabelecimento (alternativa ao header X-Merchant-Document).

string
length ≤ 500

Motivo, até 500 caracteres; volta em statusReason e no webhook.

Headers
string

CPF/CNPJ do estabelecimento (só números). Preferido; alternativa: documentId no corpo ou 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