Order Tcb Data Source

Knowledge Center > Reporting > Data Sources and Exports > Data Source Reference > Order Tcb Data Source

Order Tcb Data Source

Table of contents
No headers

This feature is only available if you have the Order Metrics feature enabled. If you wish to have access to the feature, submit a request at Zuora Global Support. We will investigate your use cases and data before enabling this feature for you. If you have the Orders feature enabled, you already have the Order Metrics feature enabled.

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.

The following objects are available in the data source.

Object Description
Order Tcb
  • 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, or Add Product
    • Contraction - Cancellation, Remove Product, or Shrink Term

    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 ID of the billing account that is billed for the subscription.
  • 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 ID of the billing account that owns the subscription.
  • Tax - The tax amount in the metric when the tax permission is enabled.
  • 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.

Account

The customer account information.

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.

Product Rate Plan

The rate plan coming from the product catalog.

Product Rate Plan Charge

The product rate plan charge information coming from the product catalog.

Rate Plan

Refers to the rate plan or pricing plan information associated the subscription.

Rate Plan Charge

The charge information associated with the subscription.

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.

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.

Last modified

Tags

Classifications

(not set)