Manage a subscription

Cancel Subscription

post

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

Path parameters

subIdstringRequired

Subscription Id

Header parameters

tokenstringRequired

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

Body

suppressCancelNotificationbooleanOptional

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

cancelReasonCodestringOptional

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

cancelCommentstringOptional

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

Responses

202

Accepted

400

* Bad request

application/json

401

Please verify your API key and secret (if applicable) is correct.

403

* Access Denied

application/json

404

* Not found

application/json

409

* Conflict

application/json

post

HTTPcURLJavaScriptPython

POST /v1/subscriptions/{subId}/cancel HTTP/1.1
Host: api.digitalriver.com
token: text
Content-Type: application/json
Accept: */*
Content-Length: 84

{
  "suppressCancelNotification": true,
  "cancelReasonCode": "text",
  "cancelComment": "text"
}

No content