latestOpenAPI 3.0.02026-08-1056429755.6 KB

a6efafc1669c

Add Coupon Codes (Asynchronous API)1

Address1

Authorized Countries2

Email Updater1

External Reference1

Get Product Task Status (Synchronous API)2

Immediate Midterm Change3

Manage Customer (Synchronous API)1

Manage Offer (Synchronous API)3

Manage Order (Synchronous API)1

Manage Product (Asynchronous API)10

Manage Subscription3

Order1

Payment2

Pending Action1

Perpetual-price1

Refund4

Retrieve Customer (Synchronous API)1

Retrieve File1

Retrieve Invoice (Synchronous API)2

Retrieve Offer (Synchronous API)1

Retrieve Order (Synchronous API)1

Retrieve Product (Synchronous API)4

Retrieve Subscription2

Source2

Subscription Renewal4

Manage 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