Manage a subscription

Cancel the subscription

This method cancels a subscription by including the subscripton ID in the {subId} URI path parameter. Once completed, the Subscription state changes to Cancelled.

POSThttps://api.digitalriver.com/v1/subscriptions/{subId}/cancel

Path parameters

subId*string

The subscription's ID.

Header parameters

Body

application/json

suppressCancelNotificationboolean

You can use this element to suppress the cancel notification email. By default, this is false.

Response

202400401403404409

Accepted

Request

JavaScriptCurlPython

const response = await fetch('https://api.digitalriver.com/v1/subscriptions/{subId}/cancel', {
    method: 'POST',
    headers: {
      "token": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

400403404409

{
  "errors": {
    "error": [
      {
        "code": "validation-error",
        "subCode": "required-data-missing",
        "description": "Missing required data: companyId"
      }
    ]
  }
}