Order Elp Data Source

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

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

You can use the Order Elp data source to report on how order actions change Extended List Price (ELP) for each of your customers.

For example, let’s say that you create an order containing the following order actions with the product's recurring catalog list price being $2 per unit per month:

  • Order Action 1: Add this rate plan and override the charge price to $10 per unit per month with the quantity being 10 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. 
  • Order Action 3: Apply a 50% discount on 1/1/2018. The discount will not impact the applied-to recurring charge's ELP.

In this scenario, Zuora will create two Order Elp metrics for the same charge:

Order Action Start Date End Date Type Value
Order Action 1 1/1/2018 12/31/2018 Regular 240 ( = 2 × 10 × 12)
Order Action 2 1/1/2018 12/31/2018 Regular 120 ( = 2 × 5 × 12)

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

The following objects are available in the data source.

Object Description
Order Elp
  • Created By ID - The Zuora user who created the metric.
  • Created Date - The date when the metric was created.
  • Discount Charge ID - Always "NULL" as the Type is always "Regular".
  • 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 with the causing order action:
    • 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 internal ID of the customer account that is billed for the subscription.

    In the case of an OwnerTansfer order action, Zuora creates two Order Elp metrics:

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

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

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

    The values of these Order Elp 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.
  • Type - The type is always "Regular".
  • Updated By ID - The Zuora user who last updated the metric.
  • Updated Date - The date when the metric was last updated.
  • Value - The extended list price calculated by the original product catalog list price multiplied by the delta 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 Elp: Subscription Owner ID” field to determine which account owns the subscription. You can use the “Order Elp: 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.

Entity

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

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

This page has no custom tags.

Classifications

(not set)