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

Parâmetros de path

string
required
Identificador único da assinatura a ser cancelada.

Parâmetros do corpo

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

Resposta

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

Exemplo de resposta

Quando at_period_end é false, o cancelamento é imediato e irreversível. Nenhum reembolso proporcional é processado automaticamente.

Erros comuns

Próximos passos

Listar assinaturas

Consulte o status de todas as assinaturas.

Criar assinatura

Crie uma nova assinatura recorrente.