Cancel a schedule

Cancels a subscription schedule and its associated subscription immediately (if the subscription schedule has an active subscription). A subscription schedule can only be canceled if its status is not_started or active.

post/v1/subscription_schedules/{schedule}/cancel

Path parameters

schedulestring required

Response

Successful response.

canceled_atinteger nullable

Time at which the subscription schedule was canceled. Measured in seconds since the Unix epoch.

completed_atinteger nullable

Time at which the subscription schedule was completed. Measured in seconds since the Unix epoch.

createdinteger required

Time at which the object was created. Measured in seconds since the Unix epoch.

customer_accountstring nullable

ID of the account who owns the subscription schedule.

end_behavior'cancel' | 'none' | 'release' | 'renew' required

Behavior of the subscription schedule and underlying subscription when it ends. Possible values are release or cancel with the default being release. release will end the subscription schedule and keep the underlying subscription running. cancel will end the subscription schedule and cancel the underlying subscription.

idstring required

Unique identifier for the object.

livemodeboolean required

If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.

metadataobject nullable

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

object'subscription_schedule' required

String representing the object's type. Objects of the same type share the same value.

released_atinteger nullable

Time at which the subscription schedule was released. Measured in seconds since the Unix epoch.

released_subscriptionstring nullable

ID of the subscription once managed by the subscription schedule (if it is released).

status'active' | 'canceled' | 'completed' | 'not_started' | 'released' required

The present status of the subscription schedule. Possible values are not_started, active, completed, released, and canceled. You can read more about the different states in our behavior guide.

Changes

Changed in 11 of the 51 revisions of this API.163853

Nov 5, 202562e8dc4ed8695See the full diff
- ○
  added the optional property /////////////// to the response with the status
  response-optional-property-added
- ○
  added the optional property /////////////// to the response with the status
  response-optional-property-added
- ○
  added the optional property ////// to the response with the status
  response-optional-property-added
- ○
  added the optional property //////////////// to the response with the status
  response-optional-property-added
- ○
  added the optional property //////////////// to the response with the status
  response-optional-property-added
Oct 22, 20251e483c60b4805See the full diff
- ○
  added the optional property /////////////////// to the response with the status
  response-optional-property-added
- ○
  added the optional property /////////////////// to the response with the status
  response-optional-property-added
- ○
  added the optional property ////////// to the response with the status
  response-optional-property-added
- ○
  added the optional property //////////////////// to the response with the status
  response-optional-property-added
- ○
  added the optional property //////////////////// to the response with the status
  response-optional-property-added
Aug 19, 20257b79777e9bbd14See the full diff
- ○
  added the optional property //////////////// to the response with the status
  response-optional-property-added
- ○
  added the optional property //////////////// to the response with the status
  response-optional-property-added
- ○
  added the optional property /////////// to the response with the status
  response-optional-property-added
- ○
  added the optional property /////////// to the response with the status
  response-optional-property-added
- ○
  added the optional property //////////////// to the response with the status
  response-optional-property-added
- ○
  added the optional property //////////////// to the response with the status
  response-optional-property-added
- ○
  added the optional property /////// to the response with the status
  response-optional-property-added
- ○
  added the optional property /////// to the response with the status
  response-optional-property-added
- ○
  added the optional property ///////////////// to the response with the status
  response-optional-property-added
- ○
  added the optional property ///////////////// to the response with the status
  response-optional-property-added
- ○
  added the optional property //////////// to the response with the status
  response-optional-property-added
- ○
  added the optional property //////////// to the response with the status
  response-optional-property-added
- ○
  added the optional property ///////////////// to the response with the status
  response-optional-property-added
- ○
  added the optional property ///////////////// to the response with the status
  response-optional-property-added
Jul 22, 2025c4dc6dbe947e7See the full diff
- ○
  added the optional property //////////////// to the response with the status
  response-optional-property-added
- ○
  added the optional property /////////// to the response with the status
  response-optional-property-added
- ○
  added the optional property //////////////// to the response with the status
  response-optional-property-added
- ○
  added the optional property /////// to the response with the status
  response-optional-property-added
- ○
  added the optional property ///////////////// to the response with the status
  response-optional-property-added
- ○
  added the optional property //////////// to the response with the status
  response-optional-property-added
- ○
  added the optional property ///////////////// to the response with the status
  response-optional-property-added
May 21, 20254b1e0a4217db3See the full diff
- ○
  added the optional property / to the response with the status
  response-optional-property-added
- ○
  added the optional property // to the response with the status
  response-optional-property-added
- ○
  added the optional property //// to the response with the status
  response-optional-property-added
Apr 21, 20259a22ca25ad2f20See the full diff
- ●
  added the new aw_tin enum value to the ///// response property for the response status
  response-property-enum-value-added
- ●
  added the new aw_tin enum value to the /////// response property for the response status
  response-property-enum-value-added
- ●
  added the new az_tin enum value to the ///// response property for the response status
  response-property-enum-value-added
- ●
  added the new az_tin enum value to the /////// response property for the response status
  response-property-enum-value-added
- ●
  added the new bd_bin enum value to the ///// response property for the response status
  response-property-enum-value-added
- ●
  added the new bd_bin enum value to the /////// response property for the response status
  response-property-enum-value-added
- ●
  added the new bf_ifu enum value to the ///// response property for the response status
  response-property-enum-value-added
- ●
  added the new bf_ifu enum value to the /////// response property for the response status
  response-property-enum-value-added
- ●
  added the new bj_ifu enum value to the ///// response property for the response status
  response-property-enum-value-added
- ●
  added the new bj_ifu enum value to the /////// response property for the response status
  response-property-enum-value-added
- ●
  added the new cm_niu enum value to the ///// response property for the response status
  response-property-enum-value-added
- ●
  added the new cm_niu enum value to the /////// response property for the response status
  response-property-enum-value-added
- ●
  added the new cv_nif enum value to the ///// response property for the response status
  response-property-enum-value-added
- ●
  added the new cv_nif enum value to the /////// response property for the response status
  response-property-enum-value-added
- ●
  added the new et_tin enum value to the ///// response property for the response status
  response-property-enum-value-added
- ●
  added the new et_tin enum value to the /////// response property for the response status
  response-property-enum-value-added
- ●
  added the new kg_tin enum value to the ///// response property for the response status
  response-property-enum-value-added
- ●
  added the new kg_tin enum value to the /////// response property for the response status
  response-property-enum-value-added
- ●
  added the new la_tin enum value to the ///// response property for the response status
  response-property-enum-value-added
- ●
  added the new la_tin enum value to the /////// response property for the response status
  response-property-enum-value-added
This revision's changelog hit the recording limit, so it may not list every change to this endpoint.
This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Feb 14, 20251199cc3c557429See the full diff
- ▲
  the response property /////////////// became optional for the status
  response-property-became-optional
- ▲
  the response property //////////// became optional for the status
  response-property-became-optional
- ○
  added the optional property /////////////// to the response with the status
  response-optional-property-added
- ○
  added the optional property ///////////// to the response with the status
  response-optional-property-added
- ○
  added the optional property //////////// to the response with the status
  response-optional-property-added
- ○
  added the optional property ////////// to the response with the status
  response-optional-property-added
- ○
  added the optional property ////// to the response with the status
  response-optional-property-added
- ○
  added the optional property ////// to the response with the status
  response-optional-property-added
- ○
  added the optional property ////// to the response with the status
  response-optional-property-added
- ○
  added the optional property ////// to the response with the status
  response-optional-property-added
- ○
  added the optional property ////// to the response with the status
  response-optional-property-added
This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jan 17, 2025b8a91ebdacb78See the full diff
- ○
  added the optional property / to the response with the status
  response-optional-property-added
- ○
  added the optional property //////// to the response with the status
  response-optional-property-added
- ○
  added the optional property //////// to the response with the status
  response-optional-property-added
- ○
  added the optional property ///////// to the response with the status
  response-optional-property-added
- ○
  added the optional property ////// to the response with the status
  response-optional-property-added
- ○
  added the optional property ////// to the response with the status
  response-optional-property-added
- ○
  added the optional property /////// to the response with the status
  response-optional-property-added
- ○
  added the optional property //// to the response with the status
  response-optional-property-added
Dec 14, 202446de5407335918See the full diff
- ●
  added the new al_tin enum value to the ///// response property for the response status
  response-property-enum-value-added
- ●
  added the new al_tin enum value to the /////// response property for the response status
  response-property-enum-value-added
- ●
  added the new al_tin enum value to the ////// response property for the response status
  response-property-enum-value-added
- ●
  added the new al_tin enum value to the /////////////// response property for the response status
  response-property-enum-value-added
- ●
  added the new al_tin enum value to the ////////////////// response property for the response status
  response-property-enum-value-added
- ●
  added the new al_tin enum value to the //////////////////// response property for the response status
  response-property-enum-value-added
- ●
  added the new al_tin enum value to the ///////////// response property for the response status
  response-property-enum-value-added
- ●
  added the new al_tin enum value to the //////////////// response property for the response status
  response-property-enum-value-added
- ●
  added the new al_tin enum value to the ////////////////// response property for the response status
  response-property-enum-value-added
- ●
  added the new al_tin enum value to the //////////// response property for the response status
  response-property-enum-value-added
- ●
  added the new al_tin enum value to the /////////////// response property for the response status
  response-property-enum-value-added
- ●
  added the new al_tin enum value to the ///////////////// response property for the response status
  response-property-enum-value-added
- ●
  added the new al_tin enum value to the ///////////// response property for the response status
  response-property-enum-value-added
- ●
  added the new al_tin enum value to the /////////////// response property for the response status
  response-property-enum-value-added
- ●
  added the new al_tin enum value to the ////////// response property for the response status
  response-property-enum-value-added
- ●
  added the new al_tin enum value to the ///////////// response property for the response status
  response-property-enum-value-added
- ●
  added the new al_tin enum value to the /////////////// response property for the response status
  response-property-enum-value-added
- ●
  added the new al_tin enum value to the /////// response property for the response status
  response-property-enum-value-added
This revision's changelog hit the recording limit, so it may not list every change to this endpoint.
Dec 11, 2024d8ab202758612See the full diff
- ○
  added the optional property ///////// to the response with the status
  response-optional-property-added
- ○
  added the optional property /////// to the response with the status
  response-optional-property-added

Of the 51 revisions, 14 have no diff computed and 6 have a changelog that could not be searched.

Full history (11 revisions)