DIdigitalriver
Manage Subscription

Cancel Subscription

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

post/v1/subscriptions/{subId}/cancel

Request

  • Base URL
    https://api.digitalriver.com
  • URL
    https://api.digitalriver.com/v1/subscriptions/{subId}/cancel
  • Auth
    none declared. Required headers: token

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

Changes

No recorded changes to this operation across all 1 revision of this API.