Skip to main content

Order Elp Data Source

Zuora

Order Elp Data Source

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.

The Order ELP feature is only available to existing Orders customers who already have access to the feature. 

Order ELP indicates how a given Order Action has changed the extended list price. It is calculated by the original product catalog list price multiplied by the delta quantity. The ELP metric is used to calculate the standalone selling price.

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, 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 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. The tax calculation during the Order creation or Orders migration is an estimated tax amount that may differ during the invoice process. Some of the reasons it may differ are address changes, tax rates, and tax exempt status. The field is not updated at invoicing time, and remains the estimated amount that was calculated during the Order creation or migration. You can stop this tax field from being generated through a subscription setting called "Calculate Tax for TCB and ELP Metrics?".
  • 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. Contains the following fields:

  • Address 1
  • Address 2
  • City
  • Country
  • Created By ID
  • Created Date
  • Display Name
  • Email
  • ID
  • Name
  • Postal Code
  • State
  • Updated By ID
  • Updated Date
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. 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.