v2

latestOpenAPI 3.1.02026-07-314524165.2 KB

Cancelar uma assinatura

Cancela imediatamente uma assinatura ativa.

A assinatura passa para o status CANCELLED e nenhuma cobrança futura será gerada. Esta operação é irreversível.

post/subscriptions/cancel

Request body

idstring required

Identificador único da assinatura a ser cancelada

Example request

{
  "id": "subs_abc123xyz"
}

Response

Assinatura cancelada com sucesso.

errorstring nullable

successboolean

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

Example response

{
  "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",
    "createdAt": "2024-11-04T18:38:28.573Z",
    "updatedAt": "2024-11-04T18:38:28.573Z"
  },
  "success": true
}