Skip to main content

Set up Ramp Metrics


Set up Ramp Metrics

This article describes how to set up the Ramp Metrics feature for Zuora Quotes.


  • Ensure that you are on Zuora Quotes 9.26 or a later version. Submit a request at Zuora Global Support to get the download link for the latest managed package.
    • If you are new to Zuora Quotes, see Install the Zuora Quotes Package to learn how to install the Zuora Quotes package.
    • If you are already using an earlier version of Zuora Quotes, follow the instruction in Upgrade Zuora Quotes to upgrade your Zuora Quotes version.
  • Ensure you have the Orders feature enabled for your Zuora tenant. The Orders feature is in the Early Adopters phase. If you want to enable this feature, submit a request at Zuora Global Support
  • Ramp metrics are only applicable to ramp deals. Therefore, you must ensure that ramp deals are also set up. See Manage ramp deals for instructions about how to enable ramp deal fields and manage ramp deals.


After the Zuora Quotes package is upgraded, take the following steps to enable the Ramp Metrics feature:

  1. Navigate to Zuora Config.
  2. Configure Quote Configuration Setting.
    1. In the Basic area, click Quote Configuration Setting.
    2. Click Edit Settings.
    3. Select the Enable Ramps Metrics checkbox, and click Save.
  3. Configure Advanced Quoting Configuration Settings.
    1. Navigate back to the Zuora Quote Configuration Settings page, and click Advanced Quoting Configuration Settings
    2. Click Edit Settings.
    3. Select the Store Existing Products checkbox, and click Save.
  4. Verify that the Enable Orders readonly checkbox is selected. If you already have the Orders enabled for your Zuora tenant but this checkbox is unselected, run the following command in the Apex Code window: 
    See Enable Zuora Tenant Settings for more information.
  5. Configure the fields for Ramp Metrics to be displayed in page layouts.
    1. Navigate to Setup > Build > Create > Objects.
    2. Locate and click the Quote object.
    3. In the Page Layout table, find the Quote page layout you want to display the metrics information, and click Edit.
      Note that to see the Quote Charge Interval Detail related list on all Quote Summary pages, you must add the related list to the following page layouts and any other active page layouts:
      • Quote Layout - Default V8.0
      • Quote Layout - Read Only v8.0
      • Quote Layout - Amendment Read-Only v8.0
      • Quote Layout - Amendment v8.0
      • Quote Layout - Cancellation ReadOnly v6.3
      • Quote Layout - Cancellation v6.3
      • Quote Layout - Renewal Read-Only V8.0
      • Quote Layout - Renewal V8.0
    4. Add the Quote Charge Interval Detail Related List to the Quote layout.
    5. Click the wrench_icon icon in the newly added Quote Charge Interval Detail section, add the following fields, and click OK:
      • Quote Rate Plan Charge
      • Start Date
      • End Date
      • Net MRR
      • Net TCB
      • Delta MRR
      • Delta TCB
      For more information about available charge metrics fields, see Quote and Charge Metrics.


After you have enabled the Ramp Metrics feature, when creating a new ramp deal, the configured Quote Charge Interval Detail related list is displayed in the UI.

The metrics in this related list are empty on the initial page load. After refreshing this page, you can see the fields in this section are populated with values.

Ramp metrics