Order Metrics
Order metrics are delta values representing the changes in key subscription metrics as a result of order actions. Metrics are tied to each Order Action that generates them, which are then linked to Orders. If there is no change in subscription metrics, an Order Action will not generate order metrics.
For instance, if you use an Update Product order action to change the number of units of a product that a customer has subscribed to, Zuora creates an Order Quantity metric to represent the "delta" between the updated number of units and the previous number of units. In other words, the value of the Order Quantity metric is the updated number of units minus the previous number of units.
All order metrics are considered to be delta metrics. In the case of an Add Product order action, the value of the corresponding Order Quantity metric is the updated number of units of the product minus the previous number of units of the product (zero). This means that the value of the Order Quantity metric is simply the number of units that the customer has subscribed to.
Zuora creates order metrics for each charge that is affected by an order action. A single change to a charge may lead to multiple order metrics for different time periods.
Availability
This feature is only available if you have the Order Metrics feature enabled. As of Zuora Billing Release 284, Orders is generally available and the Order Metrics feature is no longer available as a standalone feature.
The following objects and fields of the Order Metrics are end of support. Zuora no longer provides product support, and bug fixes or security issues are no longer addressed.
- The Order ELP and Order Item objects
- The "Generated Reason" and "Order Item ID" fields in the Order MRR, Order TCB, Order TCV, and Order Quantity objects
As of Zuora Billing Release 306, Order Metrics is no longer available. Zuora has updated the methodologies for calculating metrics in Orders. The new methodologies are reflected in the following Order Delta Metrics objects.
It is recommended that all customers use the new Order Delta Metrics. If you are an existing Order Metrics customer and want to migrate to Order Delta Metrics, submit a request at Zuora Global Support. Whereas new customers, and existing customers not currently on Order Metrics, will no longer have access to Order Metrics, existing customers currently using Order Metrics will continue to be supported.
If you are an existing Subscribe and Amend customer and want Order Delta Metrics only, you can turn on Orders Harmonization. You can still keep the existing Subscribe and Amend API integrations to create and manage subscriptions.
Access Order Metrics
Zuora provides data sources that you can use to report on order metrics:
If the lengths of the charges in a subscription become 0, for example, due to a 0 subscription term, the Order Metrics will not be calculated.
Order Metric | Key Subscription Metric |
---|---|
Order Quantity | Quantity of a charge. |
Order Mrr | Monthly recurring revenue (MRR) of a charge. |
Order Tcb |
Total contracted billing (TCB) of a charge. This is the forecast value at the time of booking for the total amount that will be billed over the duration of the charge. Discrepancies might exist between TCB and the actual invoice amount. TCB is rated at the time of booking, while the invoice amount is rated at the time of billing. As the rating time is different, several factors can lead to a discrepancy in the rated value, including but not limited to the following:
For more scenarios when discrepancies might exist between TCB and the invoice amount, see the scenarios that cause the booking and billing variances for CCV. |
Order Tcv | Total contract value (TCV) of a charge. This is the total amount that has been booked over the duration of the charge. |
Order Elp | Extended list price (ELP) of a charge. This is the quantity of the charge multiplied by the original product catalog list price of the charge, over the duration of the charge. |
If an Order Action does not generate order metrics, it will not be included in the result when querying the order metrics data source objects above.
Data query is also supported to query these order metrics. See all the available tables in data query.
You can also retrieve order metrics using the REST API. See Retrieve an order for more information.
For termed subscriptions, Zuora calculates metrics based on the subscription terms and the impact time periods:
- Subscription terms: If a subscription is renewed several times, the subscription has multiple terms. Zuora splits metrics based on the terms.
- Impact time periods: The time periods that are affected by order actions.
For example, suppose that a customer subscribes to your product for three months starting on January 1, then immediately renews the subscription for another three months. The subscription has two terms.
Later, the customer wants to change the quantity of the charge, starting on February 1. The impact period for this quantity change is from February 1 to June 30. Because the subscription already has two terms, the metrics for the quantity change are split across the two subscription terms: February 1 to March 31, then April 1 to June 30.
Zuora calculates quantity and MRR for evergreen subscriptions. You can retrieve a certain period of TCB for evergreen subscriptions using the Get order metrics for evergreen subscription REST API operation.
Order Quantity
The value of an Order Quantity metric is the change in quantity of a charge. Zuora creates Order Quantity metrics for one-time charges and recurring charges.
For example, suppose that you have subscribed a customer to 10 units of your product for 12 months, with a monthly billing period. This scenario is represented by a recurring charge with a quantity of 10 units and a duration of 12 months.
After 3 months, you use an Update Product order action to increase the quantity to 13 units. Zuora then creates an Order Quantity metric for the recurring charge. The value of the Order Quantity metric is 3 = 13 − 10 and the duration of the Order Quantity metric is 9 = 12 − 3 months.
See the "Example" section for a more detailed explanation of this scenario.
Order Mrr
The value of an Order Mrr metric is the change in monthly recurring revenue (MRR) of a charge. Zuora creates Order Mrr metrics for recurring charges only.
For example, suppose that you have subscribed a customer to 10 units of your product for 12 months, with a monthly billing period and a list price of $5.00 per unit. This scenario is represented by a recurring charge with a quantity of 10 units, a duration of 12 months, and MRR equal to $50.00 = 10 units × $5.00.
After 3 months, you use an Update Product order action to increase the quantity to 13 units, so that the new MRR of the recurring charge is $65.00 = 13 units × $5.00. Zuora then creates an Order Mrr metric for the recurring charge. The value of the Order Mrr metric is $15.00 = $65.00 − $50.00 and the duration of the Order Mrr metric is 9 = 12 − 3 months.
See the "Example" section for a more detailed explanation of this scenario.
Order Tcb
The total contracted billing (TCB) of a charge is defined as the total amount that will be billed over the duration of the charge. The value of an Order Tcb metric is the change in TCB of a charge. Zuora creates Order Tcb metrics for one-time charges and recurring charges. When no TCB change occurs, for example, adding production that only contains usage charges, the Order Tcb metric is generated and displayed as $NaN
in the TCB field.
Discrepancies might exist between TCB and the actual invoice amount. TCB is rated at the time of booking, while the invoice amount is rated at the time of billing. As the rating time is different, several factors can lead to a discrepancy in the rated value, including but not limited to the following:
- Difference in the rounding result caused by the difference in discount applying sequence or bill run scope
- Change of billing rules
- Change of customer account bill cycle day (BCD)
For more scenarios when discrepancies might exist between TCB and the invoice amount, see the scenarios that cause the booking and billing variances for CCV.
For example, suppose that you have subscribed a customer to 10 units of your product for 12 months, with a monthly billing period and a list price of $5.00 per unit. This scenario is represented by a recurring charge with a quantity of 10 units, a duration of 12 months, and TCB equal to $600.00 = 12 months × 10 units × $5.00.
After 3 months, you use an Update Product order action to increase the quantity to 13 units, so that the new TCB of the recurring charge is $735.00 = (3 months × 10 units × $5.00) + (9 months × 13 units × $5.00). Zuora then creates an Order Tcb metric for the recurring charge. The value of the Order Tcb metric is $135.00 = $735.00 − $600.00 and the duration of the Order Tcb metric is 9 = 12 − 3 months.
When calculating TCB, Zuora prorates partial months according to the billing configuration of your Zuora tenant. See Proration and Calculating Total Amount with Partial Period Proration for more information.
See the "Example" section for a more detailed explanation of this scenario, including an example of how proration affects Tcb metrics.
Order Tcv
The total contract value (TCV) of a charge is defined as the total amount that has been booked over the duration of the charge. The value of an Order Tcv metric is the change in TCV of a charge. Zuora creates Order Tcv metrics for one-time charges and recurring charges.
For example, suppose that you have subscribed a customer to 10 units of your product for 12 months, with a monthly billing period and a list price of $5.00 per unit. This scenario is represented by a recurring charge with a quantity of 10 units, a duration of 12 months, and TCV equal to $600.00 = 12 months × 10 units × $5.00.
After 3 months, you use an Update Product order action to increase the quantity to 13 units, so that the new TCV of the recurring charge is $735.00 = (3 months × 10 units × $5.00) + (9 months × 13 units × $5.00). Zuora then creates an Order Tcv metric for the recurring charge. The value of the Order Tcv metric is $135.00 = $735.00 − $600.00 and the duration of the Order Tcv metric is 9 = 12 − 3 months.
When calculating TCV, Zuora prorates partial months based on the number of days in each partial month. Zuora does not prorate partial months according to the billing configuration of your Zuora tenant. This means that the TCV and TCB of a given charge may not be the same. Zuora recommends that you use TCB in preference to TCV.
See the "Example" section for a more detailed explanation of this scenario, including an example of proration affects Order Tcv metrics.
Order Elp
The Order ELP feature is only available to existing Orders customers who already have access to the feature.
The extended list price (ELP) of a charge is defined as the quantity of the charge multiplied by the original product catalog list price of the charge, over the duration of the charge. The value of an Order Elp metric is the change in ELP of a charge. Zuora creates Order Elp metrics for one-time charges and recurring charges.
For example, suppose that you have subscribed a customer to 10 units of your product for 12 months, with a monthly billing period, and that the original list price of the product in your product catalog was $8.00 per unit. This scenario is represented by a recurring charge with a quantity of 10 units, a duration of 12 months, and ELP equal to $960.00 = 12 months × 10 units × $8.00.
After 3 months, you use an Update Product order action to increase the quantity to 13 units, so that the new ELP of the recurring charge is $1,176.00 = (3 months × 10 units × $8.00) + (9 months × 13 units × $8.00). Zuora then creates an Order Elp metric for the recurring charge. The value of the Order Elp metric is $216.00 = $1,176.00 − $960.00 and the duration of the Order Elp metric is 9 = 12 − 3 months.
When calculating ELP, Zuora prorates partial months according to the billing configuration of your Zuora tenant. See Proration and Calculating Total Amount with Partial Period Proration for more information.
See the "Example" section for a more detailed explanation of this scenario, including an example of how proration affects Elp metrics.
Example
On 1/1/2018 you use a Create Subscription order action to subscribe a customer to 10 units of your product for 1 year, with a monthly billing period. The product uses the Per Unit Pricing charge model with a list price of $8.00 per unit. When you subscribe the customer to the product, you reduce the list price to $5.00. This means that you expect to post an invoice for $50.00 ( = 10 × $5.00) each month.
Zuora then creates the following order metrics:
Order Metric | Start Date | End Date | Value | Calculation |
---|---|---|---|---|
Order Quantity |
1/1/2018 |
12/31/2018 |
10 |
Number of units |
Order Mrr |
1/1/2018 |
12/31/2018 |
50.00 |
Value of Order Quantity × list price (5.00) |
Order Tcb |
1/1/2018 |
12/31/2018 |
600.00 |
Jan-Dec: 12 months × Value of Order Mrr |
Order Tcv |
1/1/2018 |
12/31/2018 |
600.00 |
Jan-Dec: 12 months × Value of Order Mrr |
Order Elp |
1/1/2018 |
12/31/2018 |
960.00 |
Jan-Dec: 12 months × Value of Order Quantity × original list price (8.00) |
This example assumes that the customer's bill cycle day is set to the 1st of the month.
On 4/1/2018, you use an Update Product order action to increase the quantity to 13. Zuora then creates the following order metrics:
Order Metric | Start Date | End Date | Value | Calculation |
---|---|---|---|---|
Order Quantity |
4/1/2018 |
12/31/2018 |
3 |
Change in number of units |
Order Mrr |
4/1/2018 |
12/31/2018 |
15.00 |
Value of Order Quantity × list price (5.00) |
Order Tcb |
4/1/2018 |
12/31/2018 |
135.00 |
Apr-Dec: 9 months × Value of Order Mrr |
Order Tcv |
4/1/2018 |
12/31/2018 |
135.00 |
Apr-Dec: 9 months × Value of Order Mrr |
Order Elp |
4/1/2018 |
12/31/2018 |
216.00 |
Apr-Dec: 9 months × Value of Order Quantity × original list price (8.00) |
On 8/18/2018, you use another Update Product order action to further increase the quantity to 20. Zuora then creates the following order metrics:
Order Metric | Start Date | End Date | Value | Calculation |
---|---|---|---|---|
Order Quantity |
8/18/2018 |
12/31/2018 |
7 |
Change in number of units |
Order Mrr |
8/18/2018 |
12/31/2018 |
35.00 |
Value of Order Quantity × list price (5.00) |
Order Tcb |
8/18/2018 |
12/31/2018 |
156.33 |
Aug: (14 / 30 days) × value of Order Mrr = 16.33 Sep-Dec: 4 months × value of Order Mrr = 140.00 |
Order Tcv |
8/18/2018 |
12/31/2018 |
155.81 |
Aug: (14 / 31 days) × value of Order Mrr = 15.81 Sep-Dec: 4 months × value of Order Mrr = 140.00 |
Order Elp |
8/18/2018 |
12/31/2018 |
250.13 |
Aug: (14 / 30 days) × value of Order Quantity × original list price (8.00) = 26.13 Sep-Dec: 4 months × value of Order Quantity × original list price (8.00) = 224 |
This example assumes that your Zuora tenant is configured to use 30 days in a month when prorating partial months. The billing configuration of your Zuora tenant affects the calculation of TCB, but does not affect the calculation of TCV. See Proration and Calculating Total Amount with Partial Period Proration for more information.
When calculating TCV, Zuora always prorates partial months based on the actual number of days in each partial month.
On 1/1/2019, you use an Update Product order action to decrease the quantity from 20 to 16 on the charge end date. If a charge is updated on the charge end date or added to the subscription end date, a 0-length charge is created; therefore, no order metrics (such as the Order Quantity metric) will be generated,
After the preceding order action, you use a Renew order action to renew the subscription for a year. Zuora then creates the following order metrics:
Order Metric | Start Date | End Date | Value | Calculation |
---|---|---|---|---|
Order Quantity |
1/1/2019 |
12/31/2019 |
16 |
Change in number of units |
Order Mrr |
1/1/2019 |
12/31/2019 |
80.00 |
Value of Order Quantity × list price (5.00) |
Order Tcb |
1/1/2019 |
12/31/2019 |
720.00 |
Jan-Dec: 12 months × value of Order Mrr |
Order Tcv |
1/11/2019 |
12/31/2019 |
720.00 |
Jan-Dec: 12 months × value of Order Tcv |
Order Elp |
1/1/2019 |
12/31/2019 |
1536.00 |
Aug: 12 months × value of Order Quantity × original list price (8.00) |