Skip to main content
POST
Cancel a subscription

Authorizations

x-api-key
string
header
required

Your Store API key (pk_live_...). Create it in Developers › API keys.

x-store-hash
string
header
required

The ID of the store the request is for. Shown in Developers › API keys.

Path Parameters

id
string
required

Subscription ID.

Example:

"17"

Body

application/json
at_period_end
boolean
default:true

Response

Cancelled

success
boolean
required
Example:

true

subscription
object