v2

latestOpenAPI 3.0.02026-07-3139594346.4 KB
Subscriptions

Cancel Subscription

Cancel a subscription. This cancels any of the subscription's orders that are currently scheduled, paused, or payment_failed; no further orders will be placed.

post/v1/subscriptions/{subscription_id}/cancel

Path parameters

subscription_idstring required

The unique ID for a Bolt subscription.

Example:sub_1a2b3c4d5e

The unique ID for the subscription.

Headers

X-Publishable-Keystring required

The publicly viewable identifier used to identify a merchant division. This key is found in the Developer > API section of the Bolt Merchant Dashboard.

Response

Success

successboolean required

Example response

{
  "success": true
}