Skip to main content
POST
cURL

Escopo

O que faz

Cancela uma assinatura imediatamente, interrompendo todas as cobranças futuras e encerrando o acesso do cliente. O cancelamento interrompe a cobrança recorrente imediatamente. Utilize esta ação quando o cliente solicitar o encerramento definitivo ou quando a assinatura não deve mais ser renovada.

Casos de uso

  • Atender solicitação do cliente para encerramento definitivo
  • Cancelar assinaturas com pagamento inadimplente após tentativas de cobrança
  • Encerrar assinaturas de clientes que migraram para outro plano ou produto
  • Executar cancelamentos em massa via automação ou integração

Parâmetro

id (path) — Identificador único da assinatura.

Erros

Assinaturas já canceladas não podem ser canceladas novamente.

Authorizations

Authorization
string
header
required

Token de autenticação do tipo Bearer {access_token}, onde {access_token} é o token obtido no fluxo de autenticação.

Path Parameters

id
string<uuid>
required

Response

detail
string
required

Mensagem de retorno da operação

status
enum<string> | null

Status atual da assinatura após a ação

Available options:
active,
inactive,
canceled,
expired,
paused,
trial