Apply an immediate midterm change

Subscription Immediate Midterm Change API - Store cart for subscription owner

The Preview Cart API provides a preview response for the changes. Include the subscription ID in the {subId} URI path parameter and your changes in the request body.

This response includes the credit, subtotal, total tax, and total amount due to be paid if the preview changes result in an amount due. The API also returns the cart details (if created) in response to the preview API. If the "proratedUnitPrice" attribute is present, it overrides all other prices and skips normal proration. If the "proratedUnitPrice" attribute is absent, then Global Commerce pricing and proration apply. If the subscription is perpetual and you don't pass the "proratedUnitPrice" attribute into the request payload, the prorated transaction price is calculated based on the perpetual price.

POSThttps://api.digitalriver.com/v1/subscriptions/{subId}/preview-cart

Path parameters

subId*string

The subscription's ID.

Header parameters

Body

addOns*array of SubAddOnForPostReq (object)

product*ProductForPostReq (object)

quantity*integer (int32)

Product quantity

proratedUnitPricenumber

If “proratedUnitPrice” attribute is present then it overrides all other prices and skip normal proration.

Response

Body

subscriptionIdstring

Subscription id

subTotalnumber

Subscription total amount

creditnumber

Credit amount

totalAmountDuenumber

Total amount due

totalTaxnumber

Total tax

currencystring

Currency

prorationDatestring

Proration date

isCartNeededboolean

Is cart needed

isPaymentOnFileboolean

Is payment on file

previewChargesPreviewCharges (array of object)

previewSubscriptionSubAddOnChangeRequest (object)

reduceActionUrlstring

Reduct action URL

cartCartResponse (object)

Request

const response = await fetch('https://api.digitalriver.com/v1/subscriptions/{subId}/preview-cart', {
    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

{
  "subscriptionId": "text",
  "subTotal": 0,
  "credit": 0,
  "totalAmountDue": 0,
  "totalTax": 0,
  "currency": "text",
  "prorationDate": "text",
  "isCartNeeded": false,
  "isPaymentOnFile": false,
  "previewCharges": [
    {
      "productId": "text",
      "quantity": 0,
      "unitPrice": 0,
      "proratedUnitPrice": 0
    }
  ],
  "previewSubscription": {
    "addOns": [
      {
        "product": {
          "id": "text",
          "externalReferenceId": "text"
        },
        "quantity": 0,
        "proratedUnitPrice": 0
      }
    ],
    "product": {
      "id": "text",
      "externalReferenceId": "text"
    },
    "quantity": 0,
    "proratedUnitPrice": 0
  },
  "reduceActionUrl": "text",
  "cart": {
    "token": "text",
    "url": "text"
  }
}

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

addOns*array of SubAddOnForReduce (object)

product*ProductForPostReq (object)

quantity*integer (int32)

Product quantity

Response

Accepted

Request

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

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

Subscription Immediate Midterm Change API - This change doesn't store the cart for the subscription owner.

Preview Change API provides the preview response for the changes, which includes the credit, sub-total, total tax, and total amount due to be paid if the preview changes result in the due amount. Include the subscription ID in the {subId} URI path parameter and your changes in the request body.

This API does not return the cart details (if created) in the response of the preview API. When the “proratedUnitPrice” attribute is present, it overrides all other prices and skips normal proration. If the “proratedUnitPrice” attribute is absent, then Global Commerce pricing and proration apply. Suppose a subscription is perpetual, and we don’t pass the “proratedUnitPrice” attribute into the request payload. In that case, we calculate the prorated transaction price based on the perpetual price.

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

Path parameters

subId*string

The subscription's ID.

Header parameters

Body

addOns*array of SubAddOnForPostReq (object)

product*ProductForPostReq (object)

quantity*integer (int32)

Product quantity

proratedUnitPricenumber

If “proratedUnitPrice” attribute is present then it overrides all other prices and skip normal proration.

Response

Body

subscriptionIdstring

Subscription id

subTotalnumber

Subscription total amount

creditnumber

Credit amount

totalAmountDuenumber

Total amount due

totalTaxnumber

Total tax

currencystring

Currency

prorationDatestring

Proration date

isCartNeededboolean

Is cart needed

isPaymentOnFileboolean

Is payment on file

previewChargesPreviewCharges (array of object)

previewSubscriptionSubAddOnChangeRequest (object)

reduceActionUrlstring

Reduct action URL

Request

const response = await fetch('https://api.digitalriver.com/v1/subscriptions/{subId}/preview', {
    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

{
  "subscriptionId": "text",
  "subTotal": 0,
  "credit": 0,
  "totalAmountDue": 0,
  "totalTax": 0,
  "currency": "text",
  "prorationDate": "text",
  "isCartNeeded": false,
  "isPaymentOnFile": false,
  "previewCharges": [
    {
      "productId": "text",
      "quantity": 0,
      "unitPrice": 0,
      "proratedUnitPrice": 0
    }
  ],
  "previewSubscription": {
    "addOns": [
      {
        "product": {
          "id": "text",
          "externalReferenceId": "text"
        },
        "quantity": 0,
        "proratedUnitPrice": 0
      }
    ],
    "product": {
      "id": "text",
      "externalReferenceId": "text"
    },
    "quantity": 0,
    "proratedUnitPrice": 0
  },
  "reduceActionUrl": "text"
}

PreviousRenew a subscription NextManage subscription payments

Last updated 7 months ago

Subscription Immediate Midterm Change API - Store cart for subscription owner

The Preview Cart API provides a preview response for the changes. Include the subscription ID in the {subId} URI path parameter and your changes in the request body.

POSThttps://api.digitalriver.com/v1/subscriptions/{subId}/preview-cart

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

{ "subscriptionId": "text", "subTotal": 0, "credit": 0, "totalAmountDue": 0, "totalTax": 0, "currency": "text", "prorationDate": "text", "isCartNeeded": false, "isPaymentOnFile": false, "previewCharges": [ { "productId": "text", "quantity": 0, "unitPrice": 0, "proratedUnitPrice": 0 } ], "previewSubscription": { "addOns": [ { "product": { "id": "text", "externalReferenceId": "text" }, "quantity": 0, "proratedUnitPrice": 0 } ], "product": { "id": "text", "externalReferenceId": "text" }, "quantity": 0, "proratedUnitPrice": 0 }, "reduceActionUrl": "text", "cart": { "token": "text", "url": "text" } }

Subscription Immediate Midterm Change API - This change doesn't store the cart for the subscription owner.

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

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