Subscriptions
CancelSubscription
Schedules a CANCEL action to cancel an active subscription. This sets the canceled_date field to the end of the active billing period. After this date, the subscription status changes from ACTIVE to CANCELED.
post/v2/subscriptions/{subscription_id}/cancel
Path parameters
subscription_idstring required
The ID of the subscription to cancel.
Response
Success
Example response
{
"subscription": {
"canceled_date": "2023-06-05",
"card_id": "ccof:qy5x8hHGYsgLrp4Q4GB",
"created_at": "2022-01-19T21:53:10Z",
"customer_id": "CHFGVKYY8RSV93M5KCYTG4PN0G",
"id": "910afd30-464a-4e00-a8d8-2296e",
"invoice_ids": [
"inv:0-ChCHu2mZEabLeeHahQnXDjZQECY",
"inv:0-ChrcX_i3sNmfsHTGKhI4Wg2mceA"
],
"location_id": "S8GWD5R9QB376",
"paid_until_date": "2023-12-31",
"plan_variation_id": "6JHXF3B2CW3YKHDV4XEM674H",
"source": {
"name": "My Application"
},
"start_date": "2022-01-19",
"status": "ACTIVE",
"timezone": "America/Los_Angeles",
"version": 3
}
}