Skip to main content

Remove a product from an active subscription with pending charges

Zuora

Remove a product from an active subscription with pending charges

  1. Last updated
  2. Save as PDF

This tutorial demonstrates how to remove a product from an active subscription with pending charges from the Zuora UI or through the REST API.

After removing a pending charge, the charge will be removed to the time point of the estimated start date. The trigger condition is still upon a specific date. The effective start date and end date are still blank.

Remove a product from an active subscription with pending charges from the Zuora UI

To remove a product from an active subscription with pending charges, perform the following steps:

  1. Navigate to Customers > Subscriptions in the left navigation menu.
  2. Locate the subscription from which you want to remove the product and click the subscription number. The subscription detail page opens.
  3. Click Create Order. The Review Order page opens.
  4. In the Included Products tab in the Associated Subscriptions section, locate the rate plan you want to remove, and then click Remove below the rate plan name.
  5. In the dialog that appears, specify appropriate dates in the Contract effective, Service activation, and Customer acceptance fields.
  6. Click Continue.
  7. On the Review Order page, click Activate.

Remove a product from an active subscription with pending charges through the REST API

To remove a product from an active subscription with pending charges, use the Create an order operation to perform a Remove Product order action as follows:

  1. Determine the values of the following fields:
    Variable Description
    ContractEffective The date of the contract that governs the subscription. To create an active subscription with pending charges, you must specify this field.
    ServiceActivation The date on which the services or products within a subscription have been activated and access has been provided to the customer. To create an active subscription with pending charges, you must specify this field.
    CustomerAcceptance The date on which the services or products within a subscription have been accepted by the customer. To create an active subscription with pending charges, you must specify this field.
  2. Use the "Create an order" operation to remove a product:
    Request POST /v1/orders/
    Request Body 
    {
   "orderNumber": null,
   "orderDate": "2024-09-20",
   "existingAccountNumber": "A00000001",
   "subscriptions": [
       {
           "subscriptionNumber": "A-S00000027",
           "orderActions": [
               {
                   "type": "RemoveProduct",
                   "triggerDates": [
                       {
                           "triggerDate": "2024-08-29",
                           "name": "ContractEffective"
                       },
                       {
                           "name": "ServiceActivation",
                           "triggerDate": "2024-08-29"
                       },
                       {
                           "name": "CustomerAcceptance",
                           "triggerDate": "2024-08-29"
                       }
                   ],
                   "removeProduct": {
                       "ratePlanId": "f5cf07304b991db61f31dfbb96560010"
                       // This is a product rate plan that contains pending charges.
                   }
               }
           ]
       }
   ]
}