Applying a midterm change with price override

Search…

Learn how to apply a midterm change with a price override for a subscription.

Applying a midterm change with price override using the Preview cart resource
In this scenario, the customer has a basic subscription and decided to upgrade the subscription product. 
Use the POST /v1/subscriptions/{subscriptionId}/preview-cart resource to upgrade the customer's subscription product. You need to include the product identifier (id), the quantity (quantity), and the prorated Unit Price (proratedUnitPrice). In the following example, the value for the proratedUnitPrice is 20.5. 
cURL
curl --location --request POST 'https://{host}/v1/subscriptions/{subscriptionId}/preview-cart' \
--header 'Content-Type:  application/json' \
--header 'authorization: bearer ***\
--data-raw '{
  "product" : {
    "id" : "5410723500"
  },
  "quantity" : 1,
  "proratedUnitPrice" : 20.5
}'
You will receive a 200 OK response.
JSON
{
  "subscriptionId" : "29123",
  "subTotal" : 20.5,
  "credit" : 0.0,
  "totalTax" : 1.54,
  "totalAmountDue" : 22.04,
  "currency" : "USD",
  "prorationDate" : "2020-11-26",
  "previewCharges" : [ {
    "product" : "5410723500",
    "quantity" : 1,
    "unitPrice" : 20.5,
    "proratedUnitPrice" : 20.5
  } ],
  "previewSubscription" : {
    "product" : {
      "id" : "5410723500"
    },
    "quantity" : 1,
    "proratedUnitPrice" : 20.5
  },
  "cart" : {
    "token" : "bearer ff3d0ca3f03a9805f7bb7ba6d6f3ff437d6bece8fbf59bbe6041ba51520d6e135200848bdb30735576b68113ec68da16fba1379afb620d4d9a7240f50178191dd98fdd9bc7f5562d4a1fe30922798cd6616a3e0eef029b1f9d594bc8381ebace1b8cf24d2cee7a0a",
    "url" : "[https://subsgc-abe-sprint-2-ods.digitalriver.engineering/store?Action=DisplayHGOP2LandingPage&Locale=en_US&SiteID=sub2test&Token=cXYfXElGUklJQEBfT0ZUTFVGWlVJW11IJbQA&session=C629A67BACB2B8E4CD297DFBCC96A0B24E36D4E70B6C6B646C065A28D8C0AB7B27A01188AD4D093E99A0B8CF2A7A90EC3ECBAEC46E56A5BFAB6C29D2B248DAB2CA9093DA7085A931243E1C5C6C865F24009BE7A5BAF2930FF725F9FBDDE93573E12F891EB4A0EF73]"
  },
  "isCartNeeded" : true,
  "isPaymentOnFile" : true
}
Applying a midterm change with price override using the Preview resource
In this scenario, the customer has a basic subscription and decided to upgrade the subscription product. 
Use the  POST /v1/subscriptions/{subscriptionId}/preview resource to upgrade the customer's subscription product. You need to include the product identifier (id), the quantity (quantity), and the prorated Unit Price (proratedUnitPrice). In the following example, the value for the proratedUnitPrice is 20.5. 
cURL
curl --location --request POST 'https://{host}/v1/subscriptions/{subscriptionId}/preview' \
--header 'Content-Type:  application/json' \
--header 'authorization: bearer ***\
--data-raw '{    
  "product" : {
    "id" : "5410723500"
  },
  "quantity" : 1,
  "proratedUnitPrice" : 20.5
}'
You will receive a 200 OK response.
JSON
{
  "subscriptionId" : "29123",
  "subTotal" : 20.5,
  "credit" : 0.0,
  "totalTax" : 1.54,
  "totalAmountDue" : 22.04,
  "currency" : "USD",
  "prorationDate" : "2020-11-26",
  "previewCharges" : [ {
    "product" : "5410723500",
    "quantity" : 1,
    "unitPrice" : 20.5,
    "proratedUnitPrice" : 20.5
  } ],
  "previewSubscription" : {
    "product" : {
      "id" : "5410723500"
    },
    "quantity" : 1,
    "proratedUnitPrice" : 20.5
  },
    "isCartNeeded" : false,
  "isPaymentOnFile" : true
}
Applying an immediate midterm change
In this scenario, you agreed with the customer to change the subscription renewal price.
Use the POST /v1/subscriptions/{subscriptionId}/renewal-price resource to change the subscription renewal price. You need to include the subscriptionId and the renewalUnitPrice. Note that the renewalUnitPrice cannot be higher than the existing price.
cURL
curl --location --request POST 'https://{host}/v1/subscriptions/{subscriptionId}/renewal-price' \
--header 'Content-Type:  application/json' \
--header 'authorization: bearer ***\
--data-raw '{    
"renewalUnitPrice" : 4
}'
You will receive a 200 Accepted response.

Assigning a perpetual unit price

Reducing the quantity of a subscription

Last modified 2mo ago

Copy link

Outline

Applying a midterm change with price override using the Preview cart resource

Applying a midterm change with price override using the Preview resource

Applying an immediate midterm change