Skip to main content

Renew prepayment subscription

Zuora

Renew prepayment subscription

The Prepaid with Drawdown feature is in the Early Adopter phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. If you want to join this early adopter program, submit a request at Zuora Global Support.

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
  • Charge name: Monthly Plan
  • Charge type: Recurring
  • Charge model: Flat Fee
  • List price: $20/Billing period
  • Billing period: Month
  • Prepaid UOM: Million calls
  • Prepaid units: 10
  • Validity period: Month
  • Charge name: Drawdown
  • Charge type: Usage
  • Charge model: Per unit
  • List price: $5
  • UOM: Million calls

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 cannot be Evergreen. 
  • The length of the renewal term must be one or multiple times of the existing validity period
  • Renewal is allowed only when the current subscription term has at least one validity period left.