Order Item Data Source

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

Order Item 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.

If you have the Order Metrics feature enabled prior to March 2018, you can submit a request at Zuora Global Support to migrate the Order Metrics to the latest version.

Use this data source to report on the order items. 

For example, let’s say that you create an order containing the following order actions:

  • Order Action 1: Add a rate plan with a recurring charge with the unit price being $2 per unit per month and the quantity being 0 units. The term starts on 1/1/2018 and ends on 12/31/2018.
  • Order Action 2: Update the product and increase the quantity to 15 units per month on 4/1/2018. 
  • Order Action 3: Update the product and decrease the quantity to 12 units per month on 6/1/2018.

In this scenario, Zuora will create two order items for the order. An order item will only be created if the Quantity metric's amount equals to or greater than zero.

Order Action Start Date End Date Quantity
Order Action 1 1/1/2018 12/31/2018 0
Order Action 2 4/1/2018 12/31/2018 15

The following objects are available in the data source.

Object Description
Order Item
  • Created By ID - The Zuora user who created the order item.
  • Created Date - The date when the order item was created.
  • End Date - The order item's effective end date, aligned with the end date of an increased quantity order metrics (as a result of the Create Subscription, Renewal, Extend Term, Add Product, and Update Product order actions).
  • ID - The ID of the order item.
  • Quantity - The order item quantity.
  • Start Date - The order item's effective start date, aligned with the start date of an increased quantity order metrics (as a result of the Create Subscription, Renewal, Extend Term, Add Product, and Update Product order actions).
  • Updated By ID - The Zuora user who last updated the order item, now equals Created By ID.
  • Updated Date - The date when the order item was last updated, now equals Created Date.
Amendment The amendment that is tied to the rate plan, if applicable. 
Entity

The entity that the data relates to. Part of the Multi-entity feature.

Order

The order you want to view the order action information for.

Order Action The order action you want to get the TCB metrics for.
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.
Subscription

The subscription to which the rate plan is associated.

Last modified

Tags

This page has no custom tags.

Classifications

(not set)