latestOpenAPI 3.0.02026-08-101013821017.9 KB

4b69392f93b9

Access Tokens2

Address1

Addresses4

API Trigger Offer2

Apply or Detach Payment Methods3

Apply Shipping Option1

Apply Shopper1

Billing Address3

Cart Offers4

Carts2

Categories3

Email Updater1

Financing1

Immediate Midterm Change1

Inventory Status2

Line Items8

Manage The Subscription1

postCancel Subscription

Manage The The Subscription's Renewal Plan2

Offers8

Order1

Order Address2

Order Lookup1

Orders2

Payment2

Payment Methods1

Payment-Options4

Pending Action1

Price override3

Pricing1

Product Variations1

Products4

Purchase Plan1

Purchase Plan Authorize1

Purchase Plan Search1

Resume Cart1

Retrieve Subscription2

Returns2

Shipping Address3

Shipping Options2

Shoppers4

Submit Cart1

Tax Registration4

Third Party Subscription Engine Support1

Token3

Web Checkout2

Manage The Subscription

Cancel Subscription

This will cancel the subscription by subscription Id and Subscription state changes to Cancelled

post/v1/subscriptions/{subId}/cancel

Path parameters

subIdstring required

Subscription Id

Headers

tokenstring required

Basic authorization (dispatch Key and Secret) or Full access token

Request body

suppressCancelNotificationboolean

The clients can use this element to suppress cancel notification email.By default this is false.

cancelReasonCodestring

Optional, you can specify the codes used to categorize the reason for the subscription cancellation. This field can contain up to 64 characters.

cancelCommentstring

An optional comment provided by the shopper detailing additional information or context regarding the subscription cancellation. This field can contain up to 255 characters.

Response

Accepted