Skip to main content

Change the estimated start and end dates of a pending charge

Zuora

Change the estimated start and end dates of a pending charge

  1. Last updated
  2. Save as PDF

This tutorial demonstrates how to change the estimated start and end dates of a pending charge from the Zuora UI or through the REST API.

You can only modify the charge’s estimated start date. When the subscription is updated successfully, the estimated end date is automatically recalculated based on the estimated start date and the end date setting. This applies to all charge types, including one-time, recurring, and usage. Note that the estimated end date will not change if the charge end date is configured as Fixed Period after the Charge is triggered.

Change the estimated start and end dates of a pending charge from the Zuora UI

To change the estimated start and end dates of a pending charge, perform the following steps:

  1. Navigate to Customers > Subscriptions in the left navigation menu.
  2. Locate the subscription you want to update 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 pending charge you want to update, and then click Update below the rate plan name. The Update Product page opens.
  5. In the Products and Charges section, locate the rate plan charge you want to update and click the charge name to expand to the charge details.
  6. Scroll to the Timing and frequency of charge section.
  7. In the Estimated Start Date field, enter the new estimated date.
  8. Click Continue.
  9. On the Review Order page, click Activate.

Change the estimated start and end dates of a pending charge through the REST API

To change the estimated start and end dates of a pending charge, use the Create an order operation to perform an Update Product order action as follows:

The estimated start date should be within the subscription term start date and end date.

  1. 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.
  2. Use the "Create an order" operation to update the estimated start date of the pending charge:
    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-10-01"
                       },
                       {
                           "name": "ServiceActivation",
                           "triggerDate": "2024-10-01"
                       },{
                           "name": "CustomerAcceptance",
                           "triggerDate": "2024-10-01"
                          
                       }
                   ],
                   "updateProduct":{
                       "ratePlanId":"f5cf07304089445e4b4446255bec0007",
                       "chargeUpdates":[{
                           "chargeNumber":"C-00000025",
                            "estimatedStartDate":"2024-11-01"
                       }]
                   }
               }
           ]
       }
   ]
}