Order Quantity Data Source

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

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

Use the Order Quantity data source to report on how different Orders and Order Actions change quantity over time. For example, let's say you create an Order Action that increases the number of users on a per unit charge. Assume that the charge starts out with 10 users, that this Order Action adds 5 more starting on 7/1/2017, and that the subscription term ends on 12/31/2017. This Order Action would create an Order Quantity metric with a Start Date of 7/1/2017, an End Date of 12/31/2017, and a Value of 5.

See Key Metrics for Orders for more information about order metrics.

The following objects are available in the data source.

Object Description
Order Quantity
  • Created By ID - The Zuora user who created the metric.
  • Created Date - The date when the metric was created.
  • 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.
  • Updated By ID - The Zuora user who last updated the metric.
  • Updated Date - The date when the metric was last updated.
  • Value - The delta quantity value. This value could be negative or positive, depending on the purpose of the order action. For example, if the order action is reducing the quantity of the product, this value is negative. The Order Quantity metric is only created for non-zero changes in the quantity.

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 show the Quantity metrics for.
Order Action The order action you want to show the Quantity 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)