Update the price of a pending charge for a ramped subscription

Last updated
Save as PDF

This tutorial demonstrates how to update the price of a pending charge for a ramped subscription from the Zuora UI or through the REST API.

For more information about the Ramps feature, see Overview of Ramps and Ramp Metrics.

Update the price of a pending charge for a ramped subscription from the Zuora UI

To create an active subscription with a pending charge, perform the following steps:

Navigate to Customers > Subscriptions in the left navigation menu.
Locate the ramped subscription you want to update and click the subscription number. The subscription detail page opens.
Click Create Order. The Review Order page opens.
Update the price of the pending charge for a ramp interval:
1. In the Included Products tab in the Associated Subscriptions section, locate the pending charge you want to update, and then click Update below the rate plan name. The Update Product page opens.
2. In the Trigger Dates section, click the interval list icon next to the Contract effective field and select a ramp interval for which you want to update the price. This specifies the Contract effective, Service activation, and Customer acceptance fields with the previously configured dates.
3. In the Products and Charges section, locate the rate plan charge you want to update and update the price in the Price column.
4. Click the charge name to expand to the charge details.
5. Scroll to the Timing and frequency of charge section.
6. Click the interval list icon next to the Estimated Start Date field and select a ramp interval for which you want to update the price. This specifies the Estimated Start Date field with the previously configured date.
7. Click Continue.
8. Repeat steps a to g to update the price for other ramp intervals as needed.
On the Review Order page, click Activate.

Update the price of a pending charge for a ramped subscription through the REST API

To update the price of a pending charge for a ramped subscription, use the Create an order operation to perform an Update Product order action for each ramp interval as follows:

Determine the values of the following fields:

Variable	Description
`status`	The status of the order. To create an active subscription with pending charges, you must specify the `status` field to `Completed`.
`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.
`estimatedStartDate`	The estimated start date for the pending charge. Set the `estimatedStartDate` field as you want and note that this date must be a date within the subscription term. The system will then automatically calculate and determine the estimated end date for the pending charge. The estimated start and end dates are used to manage the estimated charge duration and forecast the revenue for the pending charge.

Use the "Create an order" operation to update the prices of the pending charges for an active ramped subscription:

Request POST /v1/orders/

Request Body

{
   "orderNumber": null,
   "orderDate": "2024-01-01",
   "status":"Completed",
   "existingAccountNumber": "A00000001",
   "subscriptions": [
       {
           "subscriptionNumber": "A-S00000012",
           "orderActions": [
               {
                   "type": "UpdateProduct",
                   "triggerDates": [
                       {
                           "name": "ContractEffective",
                           "triggerDate": "2024-07-01"
                       },
                       {
                           "name": "ServiceActivation",
                           "triggerDate": "2024-07-01"
                       },{
                           "name": "CustomerAcceptance",
                           "triggerDate": "2024-07-01"
                          
                       }
                   ],
                   "updateProduct":{
                       "ratePlanId":"f5cf07304089445e4b4446255bec0007",
                       "chargeUpdates":[{
                           "chargeNumber":"C-00000025",
                           "estimatedStartDate":"2024-07-01",
                           "pricing":{
                               "recurringFlatFee":{
                                   "listPrice":200
                               }
                           }
                       }]
                   }
               },{
                   "type": "UpdateProduct",
                   "triggerDates": [
                       {
                           "name": "ContractEffective",
                           "triggerDate": "2024-10-01"
                       },
                       {
                           "name": "ServiceActivation",
                           "triggerDate": "2024-10-01"
                       },{
                           "name": "CustomerAcceptance",
                           "triggerDate": "2024-10-01"
                          
                       }
                   ],
                   "updateProduct":{
                       "ratePlanId":"f5cf07304089445e4b4446255bec0007",
                       "chargeUpdates":[{
                           "chargeNumber":"C-00000025",
                            "estimatedStartDate":"2024-10-01",
                           "pricing":{
                               "recurringFlatFee":{
                                   "listPrice":300
                               }
                           }
                       }]
                   }
               }
           ]
       }
   ]
}