Skip to main content
POST
Cancel a subscription

Authorizations

X-Suby-Api-Key
string
header
required

Secret API key. sk_live_… (production) or sk_sandbox_… (sandbox).

Headers

Idempotency-Key
string

Optional key (≤255 chars, e.g. a UUID v4) making this POST safe to retry · the response is cached 24h and a retry with the SAME key replays it instead of re-executing. The same key with a different body → 422 IDEMPOTENCY_KEY_CONFLICT; a retry while the first is in flight → 409.

Maximum string length: 255
Example:

"5f3b9c2e-1a4d-4f2b-9c31-7e2a1b6d8c04"

Path Parameters

id
string
required
Example:

"sub_abc123"

Body

application/json
atPeriodEnd
boolean
default:true

true keeps access until the period end (cancelAtPeriodEnd); false cancels immediately.

Response

Cancellation scheduled or applied

success
boolean
required
Example:

true

data
object
required

Endpoint-specific payload.

message
string