Cancel recurring

POST /v1/payments/recurring/cancel/{terminal_friendly_id} Cancels a recurring billing series. All future scheduled payments are halted immediately. Any payments that were already processing at the time of cancellation may still complete.

Cancellation is permanent. Once a series is cancelled, it cannot be reactivated. If you need to resume billing for the same customer, create a new recurring agreement using the init endpoint.

Safe retries for this POST endpoint use the Idempotency-Key header. Reuse the same key only when retrying the exact same request body. See Idempotency.

curl --request POST \
  --url https://api.smartretry.com/v1/payments/recurring/cancel/ABC123 \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: YOUR_API_KEY' \
  --header 'Idempotency-Key: recurring-cancel-20260401-001' \
  --data '{
    "recurring_id": "RC9F4A2B"
  }'

import requests

response = requests.post(
    "https://api.smartretry.com/v1/payments/recurring/cancel/ABC123",
    headers={
        "Content-Type": "application/json",
        "x-api-key": "YOUR_API_KEY",
        "Idempotency-Key": "recurring-cancel-20260401-001"
    },
    json={"recurring_id": "RC9F4A2B"}
)

print(response.json())

const response = await fetch(
  "https://api.smartretry.com/v1/payments/recurring/cancel/ABC123",
  {
    method: "POST",
    headers: {
      "Content-Type": "application/json",
      "x-api-key": "YOUR_API_KEY",
      "Idempotency-Key": "recurring-cancel-20260401-001"
    },
    body: JSON.stringify({
      recurring_id: "RC9F4A2B"
    })
  }
);

const data = await response.json();
console.log(data);

Path parameters

terminal_friendly_id

string

required

Your 6-character terminal identifier.

Request body

recurring_id

string

required

The 8-character identifier of the recurring series to cancel.

Response

recurring_id

string

The identifier of the cancelled series (8 characters).

accepted

boolean

true if the cancellation was accepted and the series has been marked as cancelled.

Example response

{
  "recurring_id": "RC9F4A2B",
  "accepted": true
}

After cancellation, calling the status endpoint for this recurring_id will return status: cancelled. Historical transactions remain accessible.

Update recurring

Future transaction status

curl --request POST \
  --url https://api.smartretry.com/v1/payments/recurring/cancel/ABC123 \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: YOUR_API_KEY' \
  --header 'Idempotency-Key: recurring-cancel-20260401-001' \
  --data '{
    "recurring_id": "RC9F4A2B"
  }'

import requests

response = requests.post(
    "https://api.smartretry.com/v1/payments/recurring/cancel/ABC123",
    headers={
        "Content-Type": "application/json",
        "x-api-key": "YOUR_API_KEY",
        "Idempotency-Key": "recurring-cancel-20260401-001"
    },
    json={"recurring_id": "RC9F4A2B"}
)

print(response.json())

const response = await fetch(
  "https://api.smartretry.com/v1/payments/recurring/cancel/ABC123",
  {
    method: "POST",
    headers: {
      "Content-Type": "application/json",
      "x-api-key": "YOUR_API_KEY",
      "Idempotency-Key": "recurring-cancel-20260401-001"
    },
    body: JSON.stringify({
      recurring_id: "RC9F4A2B"
    })
  }
);

const data = await response.json();
console.log(data);

Overview

Payments

Recurring

Future Transactions

Path parameters

Request body

Response

​Path parameters

​Request body

​Response

Path parameters

Request body

Response