Change terms and conditions of prepayment subscription
Overview
After you have created a prepayment subscription through Orders, you can change the terms and conditions of this subscription for your customer.
You can extend or shorten the term of a prepayment subscription at any time during its term. See the notes and limitations section below for more information
Suppose your customer has subscribed to the following charges for 12 months from 2022-01-01 to 2022-12-31:
Product: API Calls Prepayment Service | |
Product rate plan: API Calls Monthly Prepayment Plan | |
Prepayment charge | Drawdown charge |
|
|
After a while, your customer wants to shorten the term by 3 months to 2022-09-30. You can do this for your customer through the Zuora UI or REST API.
Zuora UI
Follow the steps described in Change the terms and conditions of a subscription.
Select the desired product. In this example, change the Initial Term to 9.
See the Notes and limitations section for things to consider when changing Terms & Conditions for prepayment subscriptions.
REST API
Use the Create an order operation to change the terms and conditions of a subscription.
Sample request body: Original subscription ends on 2022-12-31, shorten it by 3 months to end on 2022/09/30.
Request | POST /v1/orders |
---|---|
Request body |
... "orderActions": [ { "type": "TermsAndConditions", "triggerDates": [ { "name": "ContractEffective", "triggerDate": "2022-01-01" }, { "name": "ServiceActivation", "triggerDate": "2022-01-01" }, { "name": "CustomerAcceptance", "triggerDate": "2022-01-01" } ], "termsAndConditions": { "lastTerm":{ "startDate":"2022-01-01", "period": 9, "periodType": "Month", "termType": "TERMED" } } } ] |
Once the order action is activated, the 30 million API calls that would be granted to the customer for the 3 validity periods (from 2022-10-01 to 2022-10-31, from 2022-11-01 to 2022-11-30, from 2022-12-01 to 2022-12-31) are removed.
You can view the customer’s prepaid balance through the Zuora UI or Data Query.
Notes and limitations
- When you extend a prepayment subscription, the number of periods must be one or multiple times of the validity period. You cannot extend the prepayment subscription to the middle of a validity period.
- The Term Start Date cannot be changed.
- Shrinking the term is allowed anytime during a validity period. To shrink the term of a subscription in the middle of a validity period, the billing periods within the validity period must all be billed. After the term is shrunk, a credit item will be generated in the next bill run to refund the subscriber based on the Credit Option you choose for the prepayment charge. If you want to reverse the change, you can delete the order (the term-shrinking order), and the prepaid units will be recovered. However, one exception is that if a validity period of the prepayment subscription contains multiple billing periods and the credit option of the recurring prepayment charge is set to "Consumption Based", when no drawdown usage is uploaded to the validity period, the subscription term cannot be shrinked.