Skip to main content

Add a Product to a Subscription

Zuora

Add a Product to a Subscription

Orders is now generally available as of Zuora Billing Release 284 (August 2019). You can access all the new capabilities in the Sandbox environment starting August 31, 2020. The Production deployment is September 10, 2020.

If you are an existing Zuora Subscribe and Amend customer and want to adopt Orders, see What is Orders Harmonization and join the Orders Harmonization community group for more information. If you want to enable Orders, submit a request at Zuora Global Support.

This tutorial demonstrates how to add a product to a subscription by creating an order.

In this tutorial, you will set the following dates to today's date:

  • The date when the order is signed
  • The contract effective date of the product addition
  • The service activation date of the product addition
  • The customer acceptance date of the product addition

Use the Zuora application

To add a product to a subscription by creating an order in the Zuora application:

  1. Navigate to Customers > Orders. The Orders page opens.

  2. Click Create New Order at the top right. The Create New Order page opens.

  3. In the Account field, enter the name of the account that owns the subscription. By default, the account that owns the order will also own the subscription.

    You can enter the account by clicking either Account Name or Account Number.

    • If you click Account Name, type part of the account name in the Account field and the filtered accounts can be dynamically listed for your selection.
    • If you click Account Number, type the complete account number.
  4. In the Order Date field, enter the order date you are to assign to the order.

  5. Choose what you want to do by clicking Amend an Existing Subscription.

  6. In the Select an existing subscription area, locate the target subscription to which you are to add products by using the Search field.

  7. On the target subscription line, click Select in the ACTION column.

    select-subscription-new-2020.png

  8. In the Associated subscriptions area, click Add Product

    add-product-2020.png

    The operations that you can perform on the selected subscription are listed to the right of the subscription number. To see other available operations, click More Order Actions.

  9. On the Trigger dates line, specify appropriate dates for the following fields. For more information, see Billing Trigger Dates.

    • Contract effective

    • Service activation

    • Customer acceptance

  10. In the Products and charges area, search and locate the product to be added. You can choose to search by product name or by product SKU by using the drop-down list. The displayed products will dynamically change as you type in the Search field.

    SearchProduct.png

  11. To add a rate plan, click the right arrow ( > ) next to the product name to expand all its rate plans, and then select the checkbox in front of the rate plan.

    You can select more than one rate plan in multiple products. To remove a rate plan from your selection, clear the checkbox in front of the rate plan. The number of the selected rate plan is also indicated in the UI.

  12. Click Add Product in the bottom right corner to continue. 

  13. (Optional): Update the charges for the selected rate plan if necessary.

  14. Click Review Order to continue. The included products are all displayed for the selected subscription.

    At this point, you can still click Add Product to add more rate plans to this subscription.

  15. (Optional): To preview billing information for the subscription, click Preview Billing. Specify the preview settings and click Update Preview to see the preview invoices. After you are finished, click Done to return to the previous page.

  16. For the new order to take effect, click Activate.

Use the REST API

You can use the "Create order" operation to add a product to a subscription.

Before the Orders feature is enabled, you would have used the "Update subscription", "Amend", or "CRUD: Create amendment" operation.

To add a product to a subscription by creating an order:

  1. Determine the values of the following variables:

    Variable Description
    $SubscriptionNum The number of the subscription to update. For example, A-S00000001.
    $AccountNum The number of the account that will own the order. For example, A00000001.
    $ProductRPId The ID of the product rate plan to add to the subscription. For example, 2c92c0f9592a69410159432fab376d81.
    $ProductRPChargeId The ID of the product rate plan charge to use when adding the product rate plan. For example, 2c92c0f9592a6941015943308a2c6e72.
    $Today Today's date. For example, 2017-09-30.
  2. Use the "Create order" operation to create an order under an existing account:

    Request POST /v1/orders/
    Request Body
    {
      "orderDate": $Today,
      "existingAccountNumber": $AccountNum,
      "subscriptions": [
        {
          "subscriptionNumber": $SubscriptionNum,
          "orderActions": [
            {
              "type": "AddProduct",
              "triggerDates": [
                {
                  "name": "ContractEffective",
                  "triggerDate": $Today
                },
                {
                  "name": "ServiceActivation",
                  "triggerDate": $Today
                },
                {
                  "name": "CustomerAcceptance",
                  "triggerDate": $Today
                }
              ],
              "addProduct": {
                "productRatePlanId": $ProductRPId,
                "chargeOverrides": [
                  {
                    "productRatePlanChargeId": $ProductRPChargeId,
                    "pricing": {
                      "recurringFlatFee": {
                        "listPrice": 10
                      }
                    }
                  }
                ]
              }
            }
          ]
        }
      ],
      "processingOptions": {
        "runBilling": false,
        "collectPayment": false
      }
    }
    

    To create the order under a new account instead of an existing account, specify the newAccount field instead of the existingAccountNumber field.

To preview invoices for the updated subscription, use the "Preview order" operation.