Skip to main content

Remove prepayment product from subscription

Zuora

Remove prepayment product from subscription

  1. Last updated
  2. Save as PDF

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 remove a product from this subscription for your customer.

Suppose your customer purchased the following product earlier on an ad-hoc basis:

Product: API Calls Prepayment Service
Product rate plan: API Calls One-Time Top-Up
Prepayment charge Drawdown charge
  • Charge name: One-time Top-up
  • Charge type: One-time
  • Charge model: Flat Fee
  • List price: $3
  • Prepaid UOM: Million calls
  • Prepaid units: 1
  • Validity period: Subscription Term
  • Charge name: API Calls Drawdown
  • Charge type: Usage
  • Charge model: Per unit
  • List price: $5
  • UOM: Million calls

After a while, your customer wants to remove the product because of a change of business. You can do this for your customer through the Zuora UI or REST API. 

Zuora UI

Follow the steps described in Remove a product from a subscription. 

See the Notes and limitations section for things to consider when removing prepayment products. 

REST API

Use the Create an order operation to remove prepayment products from an existing subscription. 

Sample request body: Remove a prepayment product from an existing subscription from 2022-07-01.

Request POST    /v1/orders
Request body 
...
"orderActions":[
   {
       "type":"RemoveProduct",
       "triggerDates":[{
           "name":"ContractEffective",
           "triggerDate":"2022-07-01"
       },
       {
           "name":"ServiceActivation",
           "triggerDate":"2022-07-01" 
       },
       {
           "name":"CustomerAcceptance",
           "triggerDate":"2022-07-01" 
       }
       ],
       "removeProduct":{
           "ratePlanId":"2c98903d7e27f4e8017e296c0b6800f7"
       }
   }
]

Once the order action is activated, the 1 million API calls included in the original subscription are removed. 

You can view the customer’s prepaid balance through the Zuora UI or Data Query. 

Notes and limitations

  • Removal is not allowed if the subscription owner has consumed some prepaid units, or purchased more prepaid units. 
  • Removal is allowed anytime during a validity period. After the removal, a time-based credit item will be generated in the next bill run to refund the subscriber. 
  • If you want to reverse the removal, you can delete the order (the removal order), and the prepaid units will be recovered.