Skip to main content

Orders Object Model

Zuora

Orders Object Model

Orders is now generally available as of Zuora Billing Release 284 (August 2019). You can access all the new capabilities in the Sandbox environment starting August 31, 2020. The Production deployment is September 10, 2020.

If you are an existing Zuora Subscribe and Amend customer and want to adopt Orders, see What is Orders Harmonization and join the Orders Harmonization community group for more information. If you want to enable Orders, 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 Objects Relationship - 2020.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 Add Product, Remove Product, and Update Product.
  • One subscription level order action affects one or more rate plans. Subscription level order action types include Create Subscription, Renewal, Cancellation, Terms and Conditions, Owner Transfer, Suspend, and Resume.

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

  • Suspend

  • Resume

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

Ramp Ramp

The Orders feature must be enabled before you can access the Ramps feature.

The Ramps feature is available for Zuora Billing customers with Enterprise and Nine editions by default. If you are a Growth customer, see Zuora Editions for pricing information.

The Ramps feature is available for all Zuora CPQ customers by default. 

The native Ramp in your Order to enable reporting Ramp Metrics for your ramp deals. See Overview of Ramps and Ramp Metrics.
Ramp Interval RampInterval The time-based periods (inside a Ramp) where products or pricing can change. See Overview of Ramps and Ramp Metrics.
Ramp Interval Metrics RampIntervalMetrics The metrics container for the TCB, TCV, and Quantity metrics at the Interval level. See Key Metrics for Ramps. You can get these metrics through the Preview order REST API operation, all the get order REST API operations, and the get ramp metrics REST API operations.
Ramp Interval MRR RampIntervalMRR The lowest level of granularity for MRR in Ramp Metrics. See Key Metrics for Ramps. See Key Metrics for Ramps. You can get these metrics through the Preview order REST API operation, all the get order REST API operations, and the get ramp metrics REST API operations.
Ramp Interval Delta Metrics RampIntervalDeltaMetrics The metrics container for the Delta TCB and Delta TCV metrics in the Interval level. See Key Metrics for Ramps. You can get these metrics through the Preview order REST API operation, all the get order REST API operations, and the get ramp metrics REST API operations.
Ramp Interval Delta MRR RampIntervalDeltaMRR The Delta MRR metrics at the Interval level. See Key Metrics for Ramps. You can get these metrics through the Preview order REST API operation, all the get order REST API operations, and the get ramp metrics REST API operations.
Ramp Interval Delta Quantity RampIntervalDeltaQuantity The Delta Quantity metrics at the Interval level. See Key Metrics for Ramps. You can get these metrics through the Preview order REST API operation, all the get order REST API operations, and the get ramp metrics REST API operations.