Manage a subscription

Cancel Subscription

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

post

/v1/subscriptions/{subId}/cancel

Path parameters

subIdstringrequired

Subscription Id

Header parameters

tokenstringrequired

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

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.

Responses

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.digitalriver.com/v1/subscriptions/{subId}/cancel' \
  --header 'token: text' \
  --header 'Content-Type: application/json'

202

400

401

403

404

409

202

No body

Accepted