Skip to main content
POST
Cancel Subscription

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

test_mode
boolean
default:true

Use test mode

Body

application/json

Request to cancel a subscription.

cancel_immediately
boolean
default:false

If true, cancels immediately. Otherwise cancels at period end.

Response

Successful Response

Cancel subscription response.

subscription_id
string
required
status
string
required
message
string
required
cancel_at
string<date-time> | null
cancelled_at
string<date-time> | null