Skip to main content

Activate a pending charge

Zuora

Activate a pending charge

This tutorial demonstrates how to activate a pending charge from the Zuora UI or through the REST API.

Activate a pending charge from the Zuora UI

To activate 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. Specify the charge trigger date:
    1. In the Included Products tab in the Associated Subscriptions section, locate the pending charge you want to activate, and then click Update below the rate plan name. The Update Product page opens.
    2. In the Products and Charges section, locate the rate plan charge you want to activate and click the charge name to expand to the charge details.
    3. Scroll to the Timing and frequency of charge section.
    4. In the Estimated Start Date field, remove the specified date. The Specific trigger date field is available.
    5. In the Specific trigger date field, enter the actual charge trigger date.
      The value must be a date within the subscription term.
    6. Click Continue.
  5. On the Review Order page, click Activate.

Activate a pending charge through the REST API

To activate a pending charge, use the Create an order operation to perform an Update Product order action as follows:

  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.
    specificTriggerDate The actual specific start date for the pending charge. Specify a date value in the specificTriggerDate field. The value must be a date within the subscription term.
  2. Use the "Create an order" operation to activate a pending charge:
    Request POST /v1/orders/
    Request Body
    {
       "orderNumber": null,
       "orderDate": "2024-03-01",
       "status":"Completed",
       "existingAccountNumber": "A00000001",
       "subscriptions": [
           {
               "subscriptionNumber": "A-S00000011",
               "orderActions": [
                   {
                       "type": "UpdateProduct",
                       "triggerDates": [
                           {
                               "name": "ContractEffective",
                               "triggerDate": "2024-11-21"
                           },
                           {
                               "name": "ServiceActivation",
                               "triggerDate": "2024-11-21"
                           },{
                               "name": "CustomerAcceptance",
                               "triggerDate": "2024-11-21"
                              
                           }
                       ],
                       "updateProduct":{
                           "ratePlanId":"f5cf073041c9445e4b444616989d0009",
                           "chargeUpdates":[{
                               "chargeNumber":"C-00000023",
                               "effectiveDate":{
                                   "specificTriggerDate":"2024-10-27"
                               }
                           }]
                       }
                   }
               ]
           }
       ]
    }