Skip to main content
POST
cURL
Cancel a recurring billing series by its recurring_id.
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.

Authorizations

x-signature
string
header
required

Lowercase hex HMAC-SHA256 of {x-timestamp}.{METHOD}.{path_with_query}.{raw_body} keyed with your API secret. See https://www.smartretry.com/docs/authentication.

x-timestamp
string
header
required

Current Unix time in seconds; must be within 5 minutes of server time and match the value used in the signature.

Headers

idempotency-key
string

Optional idempotency key, scoped to terminal + matched route pattern. A replayed request returns the cached response with Idempotency-Replayed: true. Send it exactly once (a repeated header is rejected); 1-255 characters, letters, digits, _ and - only.

Required string length: 1 - 255
Pattern: ^[\w-]+$

Path Parameters

terminal_friendly_id
string
required

The unique identifier of the terminal.

Required string length: 6
Pattern: ^[\dA-Za-z]{6}$

Body

application/json
recurring_id
string
required

The recurring series identifier.

Required string length: 8
Pattern: ^[\dA-Za-z]{8}$

Response

Default Response

recurring_id
string
required
Required string length: 8
Pattern: ^[\dA-Za-z]{8}$
cancelled
boolean
required