Encerra a assinatura de forma definitiva. As faturas ainda não cobradas (SCHEDULED, RETRYING) são canceladas (invoice.canceled); faturas pagas não são estornadas. Webhook subscription.canceled.
Atenção: uma fatura com cobrança já em andamento (OPEN) no momento do cancelamento termina normalmente e pode ser debitada. Confira GET .../invoices e, se for o caso, estorne o pagamento (POST /v1/acquiring/payments/{paymentId}/void).
Corpo opcional com reason (até 500 caracteres), que volta em statusReason.
Cancelar no fim do período pago (atPeriodEnd=true): em vez de cancelar agora, agenda o cancelamento para o próximo vencimento (cancelAt = nextDueDate). A assinatura segue ACTIVE até lá; a fatura desse vencimento não é gerada nem cobrada (se já tiver sido gerada, não é cobrada e é cancelada no dia); a Autra encerra a assinatura no dia (subscription.canceled, statusReason = o reason enviado). Webhook do agendamento: subscription.cancel_scheduled. Desfaça com DELETE .../scheduled-changes. Repetir o pedido não reagenda. Não vale para PENDING_ENROLLMENT (sem período em curso: cancele sem atPeriodEnd). Assinatura PAST_DUE tem o próximo vencimento já vencido: o cancelamento é aplicado na rodada seguinte da cobrança.
Transições
| Ação | De | Para |
|---|---|---|
| cancelar | qualquer status exceto CANCELED | CANCELED |
| suspender | ACTIVE, PAST_DUE | SUSPENDED |
| reativar | SUSPENDED | ACTIVE |
Erros — corpo {"errors":[{"code":"...","msg":"..."}]}; msg detalha o campo quando é validação:
code | HTTP | Quando acontece | O que fazer |
|---|---|---|---|
INVALID_INPUT | 400 | Campo inválido ou fora do limite; msg diz qual e a regra. | Corrija o campo indicado. |
INVALID_JSON | 400 | Corpo não é um objeto JSON válido. | Corrija o JSON. |
MISSING_DOCUMENT_ID | 400 | Estabelecimento não informado. | Envie o header X-Merchant-Document (ou documentId). |
TENANT_REQUIRED | 400 | A credencial não identifica o tenant. | Gere o token com as credenciais do seu tenant (POST /v1/oauth/token). |
FEATURE_DISABLED | 403 | O módulo de assinaturas não está habilitado para o tenant. | Peça a habilitação à Autra. |
MERCHANT_NOT_FOUND | 404 | O documento não é de um estabelecimento do seu tenant. | Confira o CPF/CNPJ do estabelecimento. |
SUBSCRIPTION_NOT_FOUND | 404 | Assinatura não existe neste estabelecimento. | Confira o id. |
INVALID_STATUS_TRANSITION | 409 | O 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_LARGE | 413 | Corpo acima de 64 KiB. | Reduza o corpo da requisição. |
INVALID_DOCUMENT | 422 | Documento do estabelecimento malformado. | CPF com 11 ou CNPJ com 14 dígitos, só números. |
INTERNAL_ERROR | 500 | Falha interna. | Tente de novo; persistindo, fale com o suporte com o horário da chamada. |
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||