Cancel a subscription

Cancel an active subscription and store the cancellation reason.

Last updated

Author: AtomicPay API

Authentication

Send your AtomicPay developer API key using Authorization: Bearer <API_KEY> or X-API-Key: <API_KEY>. This endpoint requires subscriptions.write permission, unless the key has wildcard access (*).

Path parameters

id

Required. AtomicPay subscription ID.

Request body

reason

Optional. Cancellation reason. Defaults to api_request and is limited to 100 characters.

POST/v1/subscriptions/:id/cancel

Base URL: https://api.atomicpay.com.br

Cancel an active subscription and store the cancellation reason.

Request examples

curl

curl -X POST "https://api.atomicpay.com.br/v1/subscriptions/sub_123/cancel" \
  -H "Authorization: Bearer {{api_key}}" \
  -H "Content-Type: application/json" \
  -d '{
  reason: 'customer_requested'
}'

request.js

const response = await fetch('https://api.atomicpay.com.br/v1/subscriptions/sub_123/cancel', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer {{api_key}}',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
  reason: 'customer_requested'
}),
});

const data = await response.json();

Response

response.json

{
  "id": "sub_123",
  "object": "subscription",
  "status": "canceled",
  "status_reason": "customer_requested",
  "canceled_at": 1766400000000
}

Retrieve a subscription

Retrieve one subscription by ID.

Create a custom charge

Create a one-off PIX or credit card charge through the AtomicPay public payment API.