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).

Path Parameters

id
string
required
Example:

"sub_abc123"

Body

application/json
atPeriodEnd
boolean
default:true

true keeps access until period end (sets cancelAtPeriodEnd); false cancels immediately (status CANCELED).

Response

Cancellation scheduled or applied

success
boolean
required
Example:

true

data
object
required

Endpoint-specific payload.

message
string