Orders Object Model

Knowledge Center > Subscriptions > Orders > Orders Object Model

Orders Object Model

Table of contents
No headers

This feature is only available if you have the Orders feature enabled. We are actively soliciting feedback from a small set of early adopters. If you wish to have access to the feature, submit a request at Zuora Global Support.

This article describes the objects used to support Orders. The objects provide essential information needed to create and maintain orders in Zuora.

The following diagram summarizes the Orders objects and their relationships. For the summary of all Zuora key objects, refer to Zuora Business Object Model.

Order_ERD.png

Order actions operate at the subscription level or at the rate plan level.

  • One rate plan level order action affects one rate plan. Rate plan level order action types include New Product, Remove Product, and Update Product.
  • One subscription level order action affects one or more rate plans. Subscription level order action types include Renewal, Cancellation, Terms and Conditions.

The following table lists the objects in Orders.

Object Label Object Name Description

Order

Order

Represents an agreement between a merchant and a customer, which creates or changes one or more Subscriptions.  

An Order is owned by a single Billing Account.

Corresponding data source: Order

Order Action

OrderAction

Represents the actions that are done on subscriptions, for example, create a subscription in an order, add a product, cancel, renew. Each order action operates against one subscription. 

Each order contains one or more order actions.

The following types of Order Actions are supported:

  • New Subscription

  • Update

  • Add Product

  • Remove Product

  • Update Product

  • Renew

  • Change Terms & Conditions

Corresponding data source: Order Action

Order Mrr

OrderMrr

Indicates how a given Order Action has changed discounted MRR for each charge. 

Metrics are tied to each Order Action, which are then linked to Orders.

Corresponding data source: Order Mrr

Order Tcb

OrderTcb

Indicates how a given Order Action has changed Total Contacted Billing (TCB) for each charge.

Metrics are tied to each Order Action, which are then linked to Orders.

Corresponding data source: Order Tcb

Order Tcv

OrderTcv

Indicates how a given Order Action has changed Total Contact Value (TCV) for each charge.

Metrics are tied to each Order Action, which are then linked to Orders.

Corresponding data source: Order Tcv

Order Quantity

OrderQuantity

Indicates how a given Order Action has changed quantity for each charge.

The Order Quantity metric is only created for non-zero changes in the quantity. Metrics are tied to each Order Action, which are then linked to Orders.

Corresponding data source: Order Quantity

Order Elp OrderElp

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

Corresponding data source: Order Elp

Order Item OrderItem

Represents an order item. An order item is a sales item within an order in the context of the recurring subscription business model. It can be a unit of products or a service, but defined by both quantity and term (the start and end dates). 

For the one time and the recurring charge types, if an order action causes a quantity metric creation (when the delta quantity equals to or is greater than zero), an order item is created.

The following order actions will create an order item for the one time and recurring charges. The other order actions will refer to an existing order item. Also, the Owner Transfer order action always creates an order item whose quantity field is zero.

  • Create Subscription
  • Terms and Conditions - Extend Term
  • Renewal
  • Update Product - Increase Quantity
  • Add product
  • Owner Transfer

For the usage charge type, if the order action causes a usage increase, an order item is created, and the quantity field of the order item is always set to zero.

The following order actions will create an order item for the usage charges.

  • Create Subscription
  • Terms and Conditions - Extend Term
  • Renewal
  • Add product
  • Owner Transfer

Corresponding data source: Order Item

Last modified

Tags

Classifications

(not set)