Skip to main content
POST
/
subscriptions
/
cancel
Cancelar uma assinatura
curl --request POST \
  --url https://api.abacatepay.com/v2/subscriptions/cancel \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": "subs_abc123xyz"
}
'
{
  "data": {
    "id": "subs_abc123xyz",
    "name": "Plano Premium Mensal",
    "description": "Assinatura mensal do plano premium",
    "amount": 10000,
    "currency": "BRL",
    "method": "PIX",
    "status": "PENDING",
    "customerId": "cust_abc123xyz",
    "devMode": false,
    "createdAt": "2024-11-04T18:38:28.573Z",
    "updatedAt": "2024-11-04T18:38:28.573Z"
  },
  "error": null,
  "success": true
}

Documentation Index

Fetch the complete documentation index at: https://docs.abacatepay.com/llms.txt

Use this file to discover all available pages before exploring further.

Cancela uma assinatura ativa imediatamente. Parcelas futuras pendentes são canceladas junto.

Requer a permissão SUBSCRIPTION:DELETE.

​
Corpo da requisição

CampoTipoObrigatórioDescrição
idstringSimID da assinatura (subs_...)
Exemplo: 
{
  "id": "subs_abc123xyz"
}

​
Resposta

Retorna o objeto da assinatura com status atualizado para CANCELLED. 
{
  "data": {
    "id": "subs_abc123xyz",
    "customerId": "cust_abc123xyz",
    "amount": 2990,
    "status": "CANCELLED",
    "method": "CARD",
    "coupons": [],
    "devMode": false,
    "trialDays": null,
    "trialEndsAt": null,
    "createdAt": "2024-12-06T20:00:00.000Z",
    "updatedAt": "2024-12-06T20:00:05.000Z"
  },
  "success": true,
  "error": null
}
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