Skip to main content
POST
/
subscriptions
/
cancel
/
{id}
curl -X POST 'https://api.goatpay.com.br/v1/subscriptions/cancel/clx_sub' \
  -H 'X-API-Key: gp_live_SUA_CHAVE'

{
  "success": true,
  "message": "Assinatura cancelada",
  "data": {
    "id": "clx_sub",
    "providerSubscriptionId": "sub_ext_xyz",
    "status": "CANCELED",
    "cycle": "MONTHLY",
    "billingType": "BOLETO",
    "value": 99.9,
    "description": "Plano Premium",
    "nextDueDate": "2026-08-01T00:00:00.000Z",
    "createdAt": "2026-07-01T12:00:00.000Z",
    "customer": {
      "id": "clx_customer",
      "name": "Maria Silva",
      "taxId": "12345678909"
    },
    "plan": {
      "id": "clx_plan",
      "name": "Plano Premium"
    }
  },
  "requestId": "req_abc123"
}

curl -X POST 'https://api.goatpay.com.br/v1/subscriptions/cancel/clx_sub' \
  -H 'X-API-Key: gp_live_SUA_CHAVE'

{
  "success": true,
  "message": "Assinatura cancelada",
  "data": {
    "id": "clx_sub",
    "providerSubscriptionId": "sub_ext_xyz",
    "status": "CANCELED",
    "cycle": "MONTHLY",
    "billingType": "BOLETO",
    "value": 99.9,
    "description": "Plano Premium",
    "nextDueDate": "2026-08-01T00:00:00.000Z",
    "createdAt": "2026-07-01T12:00:00.000Z",
    "customer": {
      "id": "clx_customer",
      "name": "Maria Silva",
      "taxId": "12345678909"
    },
    "plan": {
      "id": "clx_plan",
      "name": "Plano Premium"
    }
  },
  "requestId": "req_abc123"
}

​
Parâmetros de rota

​
id
string
required
ID interno da assinatura (clx_...) ou providerSubscriptionId.

Authorizations

​
X-API-Key
string
header
required

Chave gp_live_... criada em Integrações → Chaves de API no dashboard.

Path Parameters

​
id
string
required

ID do recurso (transação, cobrança, webhook, etc.)

Response

Operação concluída.

​
success
boolean
required
Example:

true

​
message
string
required
Example:

"Operação concluída com sucesso"

​
data
object
required
​
requestId
string