Skip to main content

Order Quantity Data Source

Zuora

Order Quantity Data Source

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. If you are an existing Subscribe and Amend customer and want Order Metrics only, you must 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. 

You can access all the new capabilities in the Sandbox environment starting August 31, 2020. The Production deployment is September 10, 2020.

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

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.
  • 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 Quantity metrics:

    • An Order Quantity metric where “Order Quantity: Invoice Owner ID” represents the account that was billed for the subscription before the transfer of ownership.
    • An Order Quantity metric where “Order Quantity: Invoice Owner ID” represents the account that is billed for the subscription after the transfer of ownership.

    The values of these Order Quantity 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 Quantity metrics:

    • An Order Quantity metric where “Order Quantity: Subscription Owner ID” represents the account that owned the subscription before the transfer of ownership.
    • An Order Quantity metric where “Order Quantity: Subscription Owner ID” represents the account that owns the subscription after the transfer of ownership.

    The values of these Order Quantity 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.

  • 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

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 Quantity: Subscription Owner ID” field to determine which account owns the subscription. You can use the “Order Quantity: 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 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. 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
  • 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 the subscription. Contains the following fields:

  • Amendment Type
  • Created By ID
  • Created Date
  • ID
  • Name
  • 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
  • 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
  • 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 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.