Skip to main content
POST
/
public_api
/
subscriptions
/
{id}
/
cancel
/
cURL
curl --request POST \
  --url https://api.cakto.com.br/public_api/subscriptions/{id}/cancel/ \
  --header 'Authorization: Bearer <token>'
{
  "detail": "<string>"
}

​
Escopo

    write subscriptions

​
O que faz

Cancela uma assinatura imediatamente, interrompendo todas as cobranças futuras e encerrando o acesso do cliente. Diferente da pausa, o cancelamento é irreversível. 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

StatusDescrição
400Assinatura já cancelada.
400Estado atual não permite cancelamento imediato.
404Assinatura não encontrada.
Assinaturas já canceladas não podem ser canceladas novamente. Considere a pausa como alternativa reversível.

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

Id da assinatura.

Response

Assinatura cancelada com sucesso.

​
detail
string
required

Mensagem de retorno da operação

​
status
enum<string>

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

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