Renew prepayment subscription
Overview
After you have created a prepayment subscription through Orders, you can renew the subscription for your customer.
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 renew the subscription for another 12 months from 2023-01-01 to 2023-12-31. You can do this for your customer through the Zuora UI or REST API.
Zuora UI
Follow the steps described in Renew a subscription.
See the Notes and limitations section for things to consider when renewing prepayment subscriptions.
REST API
Use the Create an order operation to cancel the subscription.
Sample request body: Renew a subscription for another 12 months with the new term start date as 2023-01-01.
Request | POST /v1/orders |
---|---|
Request body |
... "orderActions": [ { "type": "RenewSubscription", "triggerDates": [ { "name": "ContractEffective", "triggerDate": "2023-01-01" }, { "name": "ServiceActivation", "triggerDate": "2023-01-01" }, { "name": "CustomerAcceptance", "triggerDate": "2023-01-01" } ] |
Once the order action is activated, your customer is granted 10 million API calls valid to use each month from 2023-01-01 to 2023-12-31 on a use-it-or-lose-it basis.
You can view the customer’s prepaid balance through the Zuora UI or Data Query.
Notes and limitations
- Renewal term can be Evergreen. If you want to enable the support of evergreen subscriptions in the Prepaid with Drawdown feature, submit a request at Zuora Global Support.
- The length of the renewal term must be one or multiple times of the existing validity period.