Remove prepayment product from subscription

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:

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.

...
"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 allowed anytime during a validity period. To remove a product in the middle of a validity period, the billing periods within the validity period must all be billed. After the removal, 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. 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, you cannot remove the recurring prepayment charge from the subscription in the middle of the validity period.
• If you want to reverse the removal, you can delete the order (the removal order), and the prepaid units will be recovered.