Cancel a subscription. Default (cancelAtPeriodEnd=false) is immediate. Set cancelAtPeriodEnd=true to cancel at period end.
POST /v1/subscriptions/{id}/cancel
POST
/v1/subscriptions/{id}/cancel
Authorizations
Section titled “Authorizations ”Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ” id
required
string
Header Parameters
Section titled “Header Parameters ” Idempotency-Key
string
Required on every mutating /v1/* endpoint (Phase 1 fixture relaxes to optional)
Request Body required
Section titled “Request Body required ”object
cancelAtPeriodEnd
boolean
reason
string
Responses
Section titled “ Responses ”object
success
required
boolean
data
required
object
id
required
string
businessId
required
string
userId
required
string
priceId
required
string
customerId
required
string
status
required
string
cancelAtPeriodEnd
required
boolean
trialEndAt
required
string format: date-time
currentPeriodStart
required
string format: date-time
currentPeriodEnd
required
string format: date-time
retryCount
required
integer
nextRetryAt
required
string format: date-time
lastBilledAt
required
string format: date-time
billingRunId
required
string
metadata
required
createdAt
required
string format: date-time
updatedAt
required
string format: date-time
meta
required
object
requestId
required
string