Skip to main content

Add a Product in a Ramp Deal

Zuora

Add a Product in a Ramp Deal

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 in a ramp deal by creating an order. 

In this tutorial, you will add a product to an existing 3-year ramp deal that contains an annual recurring rate plan charge with three Ramp Intervals.

  • Interval 1 start date: 2020/07/01, end date: 2021/06/30, charge price: $1000/year
  • Interval 2 start date: 2021/07/01, end date: 2022/06/30, charge price: $1200/year
  • Interval 3 start date: 2022/07/01, end date: 2023/06/30, charge price: $1400/year

The product to add contains an annual recurring per unit charge. The unit price is $30/each and the default quantity is 200.

You will add the new product to Interval 3 of the ramp deal.

Use the Zuora application

To create a ramp deal 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. Click Amend an Existing Subscription at the bottom of the page. The Create Subscription page opens.

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

    SelectExistingSubscription.png

  7. At the top right of the Associated subscriptions area, click Add Product.

    AddProduct.png

  8. In the Products and charges area, 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.

    AddProduct_ProductDropDownList.png

  9. 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. In this tutorial, select Rate Plan 3.

    AddProduct_SelectRatePlan.png

    You can select more than one rate plans 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.

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

  11. In the Trigger Dates area, specify appropriate dates in the Contract EffectiveService Activation, and Customer Acceptance date fields for the operation. For more information, see Billing Trigger Dates. In this tutorial, you can click the drop-down list icon next to the contractive effective date and directly select the Interval 3 start date: 7/1/2022. The service activation and customer acceptance dates will be updated to the same date automatically.

    AddProduct_IntervalDatePicker.png

  12. (Optional): Update the charges for the selected rate plan if necessary. In this tutorial, we will use the default charge pricing in the annual per unit charge in Rate Plan 3: the price of $30/each and the quantity of 200.

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

  14. In the Included Products tab, you can view the price or quantity changes in all the Intervals by clicking the down arrow next to a value in the product and charge table. 

    AddProduct_AllQuantityChanges.png

    Alternatively, you can view the charge information in each Interval by selecting the Interval you want to view in the drop-down menu at the top right of the product and charge table.

    AddProduct_IntervalView.png

  15. To view the Interval start and end dates for each Interval in the Ramp, go to the Terms tab and identify to the Ramp section.

    RampPeriod.png

  16. To view the Ramp Metrics for each Interval, go to the Ramp Metrics tab.

    AddProduct_RampMetrics.png

  17. To activate the Order, click Activate.

Use the REST API

You can use the "Create ]order" operation to add a product to a ramp deal.

To add a product to a ramp deal 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, 2020-07-01.
    $Interval1_StartDate Interval 1 start date. For example, 2020-07-01.
    $Interval1_EndDate Interval 1 end date. For example, 2021-06-30.
    $Interval2_StartDate Interval 2 start date. For example, 2021-07-01.
    $Interval2_EndDate Interval 2 end date. For example, 2022-06-30.
    $Interval3_StartDate Interval 3 start date. For example, 2022-07-01.
    $Interval3_EndDate Interval 3 end date. For example, 2023-06-30.
  2. Use the "Create and activate order" operation to create an order under an existing account:

    Request POST /v1/orders/
    Request Body
    {
      "orderDate": $Today,
      "existingAccountNumber": $AccountNum,
      "subscriptions": [
        {
          "subscriptionNumber": $SubscriptionNum,
          "ramp": {
                "intervals": [
                    {
                        "name": "Interval 1",
                        "startDate": "$Interval1_StartDate",
                        "endDate": "$Interval1_EndDate"
                    },
                    {
                        "name": "Interval 2",
                        "startDate": "$Interval2_StartDate",
                        "endDate": "$Interval2_EndDate"
                    },
                    {
                        "name": "Interval 3",
                        "startDate": "$Interval3_StartDate",
                        "endDate": "$Interval3_EndDate"
                    }
                ]
            },
          "orderActions": [
            {
              "type": "AddProduct",
              "triggerDates": [
                {
                  "name": "ContractEffective",
                  "triggerDate": $Today
                },
                {
                  "name": "ServiceActivation",
                  "triggerDate": $Today
                },
                {
                  "name": "CustomerAcceptance",
                  "triggerDate": $Today
                }
              ],
              "addProduct": {
                "productRatePlanId": $ProductRPId,
                "chargeOverrides": [
                  {
                    "productRatePlanChargeId": $ProductRPChargeId,
                    "pricing": {
                      "recurringPerUnit": {
                        "listPrice": 30,
                        "quantity": 200
                      }
                    }
                  }
                ]
              }
            }
          ]
        }
      ],
      "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.