Skip to main content
POST
Cancelar uma assinatura
Cancela uma assinatura ativa imediatamente. Parcelas futuras pendentes são canceladas junto.

Requer a permissão SUBSCRIPTION:DELETE.

Corpo da requisição

Exemplo:

Resposta

Retorna o objeto da assinatura com status atualizado para CANCELLED.
O cancelamento é aplicado na hora (cancelPolicy: NOW). Não há período de carência — o cliente perde o acesso imediatamente.

Authorizations

Authorization
string
header
required

Todas as requisições devem incluir sua chave de API no header Authorization usando o formato Bearer <abacatepay-api-key>. Sem esse header a requisição será rejeitada.

Saiba mais sobre como criar e usar chaves de API na documentação de autenticação.

Body

application/json
id
string
required

Identificador único da assinatura a ser cancelada

Example:

"subs_abc123xyz"

Response

Assinatura cancelada com sucesso.

data
object

Dados de uma assinatura (subscription).

error
string | null
Example:

null

success
boolean

Se a requisição obteve sucesso ou não.

Example:

true