Order Tcb data source | Zuora | Developer Documentation

A data source to report on how order actions change Total Contracted Billing (TCB) for each of your customers.

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 Order metrics for more information about order metrics.

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.

Order Delta Mrr
Order Delta Tcv
Order Delta Tcb

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.

Accessing the data source

Navigation: Go to Reporting > Data Sources and select Order Tcb as the data source.

Base object description

The following table provides descriptions for the base object.

Object	Description
Order Tcb	The following Order Metrics have been deprecated. Any new customers who onboard on Orders or Orders Harmonization will not get these metrics. 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 Existing Orders customers who have these metrics will continue to be supported. Created By ID - The Zuora user who created the metric. Created Date - The date when the metric was created. Discount Charge ID - The internal ID of the discount charge. Only applicable if Type is “Discount”. End Date - The latest date that the metric applies. Generated Reason - The reason why the metrics are generated by the certain order action. The value can be one of the following: IncreaseQuantity - Update Product by increasing the quantity DecreaseQuantity - Update Product by decreasing the quantity ChangePrice - Update Product by changing the price Extension - Create Subscription, Renewal, Extend Term, Add Product, or Resume Contraction - Cancellation, Remove Product, Shrink Term, or Suspend IncreaseQuantity, DecreaseQuantity, and ChangePrice indicate changes in terms of value while Extension and Contraction indicate changes in terms of time period. ID - The internal ID of the metric. Invoice Owner ID - The internal ID of the customer account that is billed for the subscription. In the case of an OwnerTansfer order action, Zuora creates two Order Tcb metrics: An Order Tcb metric where “Order Tcb: Invoice Owner ID” represents the account that was billed for the subscription before the transfer of ownership. An Order Tcb metric where “Order Tcb: Invoice Owner ID” represents the account that is billed for the subscription after the transfer of ownership. The values of these Order Tcb metrics have opposite signs. Order Item ID - The ID of the order item referenced by the order metrics. Start Date - The earliest date that the metric applies. Subscription Owner ID - The internal ID of the customer account that owns the subscription. In the case of an OwnerTansfer order action, Zuora creates two Order Tcb metrics: An Order Tcb metric where “Order Tcb: Subscription Owner ID” represents the account that owned the subscription before the transfer of ownership. An Order Tcb metric where “Order Tcb: Subscription Owner ID” represents the account that owns the subscription after the transfer of ownership. The values of these Order Tcb metrics have opposite signs. Term Number - A number that tells you the position of a term in a subscription, in the context of a recurring business. When a subscription is renewed, the term number will increase by one. Tax - The tax amount in the metric when the tax permission is enabled. The tax calculation during the Order creation or Orders migration is an estimated tax amount that may differ during the invoice process. Some of the reasons it may differ are address changes, tax rates, and tax exempt status. The field is not updated at invoicing time, and remains the estimated amount that was calculated during the Order creation or migration. You can stop this tax field from being generated through a subscription setting called “Calculate Tax for TCB and ELP Metrics?”. For more information, refer to default subscription settings Type - If Type is “Regular”, the metric represents the TCB of a regular charge. If Type is “Discount”, the metric represents the TCB of a discount charge that is applied to a regular charge. To obtain information about the regular charge, use the Rate Plan Charge object in the data source. Updated By ID - The Zuora user who last updated the metric. Updated Date - The date when the metric was last updated. Value - The monthly recurring revenue associated with the charge. This value could be negative or positive, depending on the value of Type and the purpose of the order action. For example, if Type is “Regular” and the order action is reducing the price of the product, this value is negative.

Object

Description

Order Tcb

The following Order Metrics have been deprecated. Any new customers who onboard on Orders or Orders Harmonization will not get these metrics.

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

Existing Orders customers who have these metrics will continue to be supported.

Created By ID - The Zuora user who created the metric.
Created Date - The date when the metric was created.
Discount Charge ID - The internal ID of the discount charge. Only applicable if Type is “Discount”.
End Date - The latest date that the metric applies.
Generated Reason - The reason why the metrics are generated by the certain order action. The value can be one of the following:
- IncreaseQuantity - Update Product by increasing the quantity
- DecreaseQuantity - Update Product by decreasing the quantity
- ChangePrice - Update Product by changing the price
- Extension - Create Subscription, Renewal, Extend Term, Add Product, or Resume
- Contraction - Cancellation, Remove Product, Shrink Term, or Suspend
IncreaseQuantity, DecreaseQuantity, and ChangePrice indicate changes in terms of value while Extension and Contraction indicate changes in terms of time period.
ID - The internal ID of the metric.
Invoice Owner ID - The internal ID of the customer account that is billed for the subscription.

In the case of an OwnerTansfer order action, Zuora creates two Order Tcb metrics:
- An Order Tcb metric where “Order Tcb: Invoice Owner ID” represents the account that was billed for the subscription before the transfer of ownership.
- An Order Tcb metric where “Order Tcb: Invoice Owner ID” represents the account that is billed for the subscription after the transfer of ownership.
The values of these Order Tcb metrics have opposite signs.
Order Item ID - The ID of the order item referenced by the order metrics.
Start Date - The earliest date that the metric applies.
Subscription Owner ID - The internal ID of the customer account that owns the subscription.

In the case of an OwnerTansfer order action, Zuora creates two Order Tcb metrics:
- An Order Tcb metric where “Order Tcb: Subscription Owner ID” represents the account that owned the subscription before the transfer of ownership.
- An Order Tcb metric where “Order Tcb: Subscription Owner ID” represents the account that owns the subscription after the transfer of ownership.
The values of these Order Tcb metrics have opposite signs.
Term Number - A number that tells you the position of a term in a subscription, in the context of a recurring business. When a subscription is renewed, the term number will increase by one.
Tax - The tax amount in the metric when the tax permission is enabled. The tax calculation during the Order creation or Orders migration is an estimated tax amount that may differ during the invoice process. Some of the reasons it may differ are address changes, tax rates, and tax exempt status. The field is not updated at invoicing time, and remains the estimated amount that was calculated during the Order creation or migration. You can stop this tax field from being generated through a subscription setting called “Calculate Tax for TCB and ELP Metrics?”. For more information, refer to default subscription settings
Type - If Type is “Regular”, the metric represents the TCB of a regular charge. If Type is “Discount”, the metric represents the TCB of a discount charge that is applied to a regular charge. To obtain information about the regular charge, use the Rate Plan Charge object in the data source.
Updated By ID - The Zuora user who last updated the metric.
Updated Date - The date when the metric was last updated.
Value - The monthly recurring revenue associated with the charge. This value could be negative or positive, depending on the value of Type and the purpose of the order action. For example, if Type is “Regular” and the order action is reducing the price of the product, this value is negative.

The following table provides descriptions for related objects.

Object	Description
Account	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.
Bill To	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.
Parent Account	Refers to the parent account associated with the customer account, if applicable.
Product	The product information. Contains the following fields: AllowFeatureChanges Category Created By ID Created Date Description Effective End Date Effective Start Date ID Name NetSuite Integration ID NetSuite Integration Status NetSuite Item Type NetSuite Sync Date SKU Updated By ID Updated Date
Product Rate Plan	The rate plan coming from the product catalog. Contains the following fields: Created By ID Created Date Description Effective End Date Effective Start Date ExternalldSourceSystem Grade ID Name Updated By ID Updated Date
Product Rate Plan Charge	The product rate plan charge information coming from the product catalog. Contains the following fields: Accounting Code Apply Discount To Bill Cycle Day Bill Cycle Type Billing Period Billing Period Alignment Billing Timing Charge Model Charge Type Created By ID Created Date Default Quantity Deferred Revenue Account Description Discount Level End Date Condition ID Included Units Legacy Revenue Reporting List Price Base Max Quantity Min Quantity Name Number Of Period Overage Calculation Option Overage Unused Units Credit Option Price Change Option Price Increase Percentage Rating Group Recognized Revenue Account Revenue Recognition Code Revenue Recognition Rule Name Revenue Recognition Trigger Smoothing Model Specific Billing Period Tax Code Tax Mode Taxable Trigger Event UOM Up To How Many Periods Up To Periods Type Updated By ID Updated Date Usage Records Rating Option Use Discount Specific Accounting Code Use Tenant Default For Price Change Weekly Bill Cycle Day
Rate Plan	Refers to the rate plan or pricing plan information associated with the subscription. Contains the following fields: Amendment Type: Note that a filter on this field using the unequal operator cannot return those Rate Plan records with a blank Amendment Type field. Created By ID Created Date Externally Managed Plan ID: a text field. This field indicates the unique identifier of a rate plan purchased on a third-party store. ID Invoice Owner ID: the invoice owner ID of the subscription that contains the rate plan Name Original Rate Plan ID: the original ID of the subscription rate plan, which is the ID of the subscription rate plan in the version-1 subscription Subscription Owner ID: the subscription owner ID of the subscription that contains the rate plan Subscription Rate Plan Number Updated By ID Updated Date
Rate Plan Charge	The charge information associated with the subscription. Contains the following fields: Accounting Code Apply Discount To Bill Cycle Day Bill Cycle Type Billing Period Billing Period Alignment Billing Timing Charge Model Charge Number Charge Type Charged Through Date Created By ID Created Date DMRC DTCV Description Discount Level Effective End Date Effective Start Date End Date Condition ID Invoice Owner ID: the invoice owner ID of the subscription that contains the rate plan charge Is Last Segment Is Processed List Price Base MRR Name Number of Periods Original ID Overage Calculation Option Overage Unused Units Credit Option Price Change Option Price Increase Percentage Processed Through Date Quantity Rating Group Revenue Recognition Code Revenue Recognition Rule Name Revenue Recognition Trigger Condition Segment Specific Billing Period Specific End Date Subscription Id: the ID of the subscription that contains the rate plan charge Subscription Owner ID: the subscription owner ID of the subscription that contains the rate plan charge TCV Trigger Date Trigger Event Unit of Measure Up To Periods Up To Periods Type Updated By ID Updated Date Version Weekly Bill Cycle Day
Sold To	The contact associated with the account to whom your product or service is sold.
Subscription	The subscription to which the rate plan is associated. Contains the following fields: Auto Renew Cancelled Date Contract Acceptance Date Contract Effective Date Cpq Bundle Json ID Created By ID Created Date Creator Account ID Creator Invoice Owner ID Current Term Current Term Period Type ID Initial Term Initial Term Period Type Invoice Owner ID Invoice Separate Name Notes Opportunity Close Date Opportunity Name Original Created Date Original ID Previous Subscription ID Quote Business Type Quote Number Quote Type Renewal Setting Renewal Term Renewal Term Period Type Service Activation Date Status Subscription End Date Subscription Start Date Term End Date Term Start Date Term Type Updated By ID Updated Date Version
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. If you have the Orders feature enabled, consider the following depending on different tenant types: If you are in the Orders tenants, the Subscription Version Amendment object is not available; you should use the Order object instead. If you are in the Orders Harmonization tenants, and the subscription version was created through an order, the Subscription Version Amendment object is available. However, if the order has multiple order actions, since the type of amendment is a composite type, the exported data does not include any change detail.

Availability

Accessing the data source

Base object description

Related object description