Apply an immediate midterm change

PreviousRenew a subscription NextManage subscription payments

Last updated 10 months ago

Subscription Immediate Midterm Change API - Store cart for 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 results in due amount. This API return the cart details (if created) in the response of the preview API. If “proratedUnitPrice” attribute is present then it overrides all other prices and skip normal proration. If “proratedUnitPrice” attribute is not present then GC pricing and proration applies. If subscription is perpetual subscription and we don’t pass “proratedUnitPrice” attribute into the request payload then prorated transaction price calculates on the basis of perpetual price.

post

/v1/subscriptions/{subId}/preview-cart

Path parameters

subIdstringrequired

Subscription Id

Header parameters

tokenstringrequired

Basic authorization (dispatch Key and Secret) - Client Admin key

principalstring

principal header is required only for price overriding. By default principal type will be a site. Other principal type (company, user) need to pass explicitly in header.

Body

productobjectrequired

quantityinteger · int32required

Product quantity

proratedUnitPricenumber

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

addOnsobject[]required

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.digitalriver.com/v1/subscriptions/{subId}/preview-cart' \
  --header 'token: text' \
  --header 'Content-Type: application/json' \
  --data '{"product":{},"quantity":1,"addOns":[{"product":{},"quantity":1}]}'

200

400

401

403

404

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

Reduce Subscription's Quantity Or Addons

This API to change the subscription quantity immediately so that client have increased subscription management capability via API

post

/v1/subscriptions/{subId}/reduce

Path parameters

subIdstringrequired

Subscription Id

Header parameters

tokenstringrequired

Basic authorization (dispatch Key and Secret) - Client Admin key or Full access token

Body

productobjectrequired

quantityinteger · int32required

Product quantity

addOnsobject[]required

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.digitalriver.com/v1/subscriptions/{subId}/reduce' \
  --header 'token: text' \
  --header 'Content-Type: application/json' \
  --data '{"product":{},"quantity":1,"addOns":[{"product":{},"quantity":1}]}'

202

400

401

403

404

No body

Accepted

Subscription Immediate Midterm Change API - Doesn't store cart for 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 results in due amount. This API does not return the cart details (if created) in the response of the preview API. If “proratedUnitPrice” attribute is present then it overrides all other prices and skip normal proration. If “proratedUnitPrice” attribute is not present then GC pricing and proration applies. If subscription is perpetual subscription and we don’t pass “proratedUnitPrice” attribute into the request payload then prorated transaction price calculates on the basis of perpetual price.

post

/v1/subscriptions/{subId}/preview

Path parameters

subIdstringrequired

Subscription Id

Header parameters

tokenstringrequired

Basic authorization (dispatch Key and Secret) - Client Admin key

principalstring

principal header is required only for price overriding. By default principal type will be a site. Other principal type (company, user) need to pass explicitly in header.

Body

productobjectrequired

quantityinteger · int32required

Product quantity

proratedUnitPricenumber

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

addOnsobject[]required

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.digitalriver.com/v1/subscriptions/{subId}/preview' \
  --header 'token: text' \
  --header 'Content-Type: application/json' \
  --data '{"product":{},"quantity":1,"addOns":[{"product":{},"quantity":1}]}'

200

400

401

403

404

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