Apply an immediate midterm change

Reduce the subscription's quantity or add-ons

This method immediately decreases the number of subscription items or product add-ons by including the subscription ID in the {subId} URI path parameter and your changes in the request body.

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

Path parameters

subId*string

The subscription's ID.

Header parameters

Body

application/json

addOns*array of SubAddOnForReduce (object)

product*ProductForPostReq (object)

quantity*integer (int32)

Product quantity

Response

202400401403404

Accepted

Request

JavaScriptCurlPython

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

Response

400403404

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