Order Tcb Data Source
You can use the Order Tcb data source to report on how order actions change Total Contracted Billing (TCB) for each of your customers.
For example, let’s say that you create an order containing the following order actions:
- Add a rate plan with a recurring charge of $50 per month. The term starts on 1/1/2018 and ends on 12/31/2018. A 10% discount applies to the charge.
- Remove the discount on 4/1/2018.
In this scenario, Zuora will create three Order Tcb metrics for the same charge:
|Start Date||End Date||Type||Value|
|1/1/2018||12/31/2018||Regular||600 ( = 50 × 12)|
|1/1/2018||12/31/2018||Discount||-60 ( = -5 × 12)|
|4/1/2018||12/31/2018||Discount||45 ( = 5 × 9)|
See Key Metrics for Orders for more information about order metrics.
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.
As of Zuora Billing Release 284, the following Order Metrics have been deprecated. Existing Orders customers who have these metrics will continue to be supported.
- 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. Join the Orders Harmonization community group for more information. You can still keep the existing Subscribe and Amend API integrations to create and manage subscriptions.
Accessing the Data Source
Navigation: Reporting > Data Sources and select Order Tcb as the data source.
Data Source Details
The following base and related (joint) objects are available for the Order TCB.
Base Object Description
The following table provides descriptions for the base object.
The following Order Metrics have been deprecated. Any new customers who onboard on Orders or Orders Harmonization will not get these metrics.
Existing Orders customers who have these metrics will continue to be supported.
Related Object Description
The following table provides descriptions for related objects.
Information about the customer account that owns the order. This account may not be the account that owns the subscription or is billed for the subscription.
You can use the “Order Tcb: Subscription Owner ID” field to determine which account owns the subscription. You can use the “Order Tcb: Invoice Owner ID” field to determine which account is billed for the subscription.
|Amendment||The amendment that is tied to the rate plan, if applicable.|
The contact associated with the account to whom your product or service is billed.
|Default Payment Method||
The default payment method used to make payments.
|Order||The order you want to get the TCB metrics for.|
|Order Action||The order action you want to get the TCB metrics for.|
Refers to the parent account associated with the customer account, if applicable.
The product information. Contains the following fields:
|Product Rate Plan||
The rate plan coming from the product catalog. Contains the following fields:
|Product Rate Plan Charge||
The product rate plan charge information coming from the product catalog. Contains the following fields:
Refers to the rate plan or pricing plan information associated with the subscription. Contains the following fields:
|Rate Plan Charge||
The charge information associated with the subscription. Contains the following fields:
The contact associated with the account to whom your product or service is sold.
The subscription to which the rate plan is associated. Contains the following fields:
|Subscription Bill To||The bill-to contact of a subscription.|
|Subscription Bill To Snapshot||A copy of the bill-to contact information of a subscription.|
|Subscription Version Amendment||
The amendment that is responsible for creating the particular subscription version. This amendment corresponds directly to the Order object. If you have the Orders feature enabled, the Subscription Version Amendment object is not available; you should use the Order object instead.