Skip to main content

​
Visão geral

Use este endpoint para cancelar uma assinatura. Por padrão, o cancelamento é agendado para o final do ciclo de cobrança vigente, permitindo que o cliente continue com acesso até essa data. Também é possível solicitar o cancelamento imediato.

​
Endpoint

curl -X POST https://api.avanttifinance.com/v1/subscriptions/{subscription_id}/cancel \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json" \
  -d '{
    "at_period_end": true
  }'

​
Parâmetros de path

​
subscription_id
string
required
Identificador único da assinatura a ser cancelada.

​
Parâmetros do corpo

​
at_period_end
boolean
Quando true (padrão), o cancelamento é agendado para o final do ciclo de cobrança atual. Quando false, a assinatura é cancelada imediatamente.

​
Resposta

​
id
string
Identificador único da assinatura.
​
status
string
Novo status da assinatura. Será active (com cancelamento agendado) ou canceled, dependendo do parâmetro at_period_end.
​
cancel_at
string
Data e hora em que a assinatura será efetivamente cancelada, no formato ISO 8601.
​
canceled_at
string
Data e hora em que o cancelamento foi solicitado, no formato ISO 8601.

​
Exemplo de resposta

{
  "id": "sub_8f72a1b3c4d5",
  "status": "active",
  "cancel_at": "2025-02-15T10:30:00Z",
  "canceled_at": "2025-01-15T14:22:00Z"
}
Quando at_period_end é false, o cancelamento é imediato e irreversível. Nenhum reembolso proporcional é processado automaticamente.

​
Erros comuns

Código HTTPSignificado
401Token de autenticação inválido ou ausente
404Assinatura não encontrada
409Assinatura já está cancelada

​
Próximos passos

Listar assinaturas

Consulte o status de todas as assinaturas.

Criar assinatura

Crie uma nova assinatura recorrente.