Skip to main content

Create an active subscription with pending charges

Zuora

Create an active subscription with pending charges

  1. Last updated
  2. Save as PDF

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

Create an active subscription with a pending charge from the Zuora UI

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

  1. Navigate to Customers > Orders in the left navigation menu.
  2. Click Create New Order. The Create New Order page opens.
  3. Specify the order details:
    • In the Account field, specify the customer account that owns the order.
    • In the Order Date field, specify the date when the order is signed.
    • Select the Create "completed" order with pending charges checkbox.
  4. In the Associated Subscriptions section, click Create Subscription. The Create Subscription page opens.
  5. Specify the subscription details, such as subscription term and billing information.
  6. Click Continue.
  7. In the Products and Charges section, select the product rate plan you want to add to the subscription, and then click Add Product.
  8. Update the rate plan charge settings:
    1. Click the charge name to expand the charge details.
    2. Scroll to the Timing and frequency of charge section.
    3. From the Trigger Condition list, select Upon a specific date.
    4. In the Estimated Start Date field, enter the estimated date when the charge will start.
    5. From the End Date list, select an option for calculating the charge end date. Zuora uses this value to calculate the estimated end date when the charge is in pending status.
    6. Click Review Order.
      On the preview page, PENDING next to the charge name indicates the charge will be in pending status when the subscription is created.
  9. Click Activate.

When the order and subscription are created successfully, the order is in Completed status and the subscription is in Active status.

Create an active subscription with a pending charge through the REST API

To create an active subscription with a pending charge, use the Create an order operation to perform a Create Subscription 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.
    triggerEvent The trigger condition for the charge to become active. To create an active subscription with pending charges, you must specify the triggerEvent field to SpecificDate but without specifying a value in the specificTriggerDate 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 create an active subscription with a pending charge:
    Request POST /v1/orders/
    Request Body 
    {
   "existingAccountNumber": "A00000001",
   "status":"Completed",
   "orderDate": "2024-07-03",
   "subscriptions": [
       {
           "orderActions": [
               {
                   "type": "CreateSubscription",
                   "triggerDates": [
                       {
                           "triggerDate": "2024-08-29",
                           "name": "ContractEffective"
                       },
                       {
                           "name": "ServiceActivation",
                           "triggerDate": "2024-08-29"
                       },
                       {
                           "name": "CustomerAcceptance",
                           "triggerDate": "2024-08-29"
                       }
                   ],
                   "createSubscription": {
                       "terms": {
                           "initialTerm": {
                               "startDate": "2024-07-03",
                               "period": 6,
                               "periodType": "Month",
                               "termType": "TERMED"
                           },
                           "renewalTerms": [
                               {
                                   "period": 1,
                                   "periodType": "Month"
                               }
                           ],
                           "autoRenew": false,
                           "renewalSetting": "RENEW_WITH_SPECIFIC_TERM"
                       },
                       "subscribeToRatePlans": [
                           {
                               "productRatePlanId": "f5cf07304ce942618c7429befc0e0000",
                               "chargeOverrides": [
                                   {
                                       "productRatePlanChargeId": "f5cf07304ce942618c7429bf83b30003",
                                       "estimatedStartDate": "2024-09-27",
                                       "startDate": {
                                           "triggerEvent": "SpecificDate"
                                       }
                                   }
                               ]
                           }
                       ]
                   }
               }
           ]
       }
   ]
}