This article introduces Orders and Order Metrics. If you have enabled Multi-entity, the Orders feature is enabled on an individual entity basis.
See Orders Tutorials for how to use Orders.
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.
What is an Order?
An Order represents the transaction record. With Orders, you can create multiple subscriptions and manage multiple changes to a subscription. Every change you make to a subscription, you get the change impact with Order Metrics.
Major benefits of Orders are the following:
Simplified process of booking complex deals in Zuora
Use multiple Order Actions to create complex deal structures in a single Order, making it easier to manage and report on those complex deals
Order Metrics, such as the change in Total Contracted Billing (TCB), change in discounted Monthly Recurring Revenue (MRR), and change in quantity are available for each charge.
Billing tied to the whole Order
Track downstream billing by Order so that you can readily determine the billed and unbilled amounts for easier accounting.
Ramp deal management
Create a ramp deal with native Ramps and Ramp Metrics based on Ramp Intervals, such as Ramp Interval MRR and Ramp Interval TCB for each charge.
The following components represent an Order:
A contractual agreement between a merchant and a customer. One Order can affect multiple subscriptions which belong to the same invoice owner account. These Subscriptions can be owned by multiple customers.
The content of an Order, representing the actions that are done on subscriptions, for example, create a subscription, add a product, renewal. An Order can have one or more Order Actions, and each Order Action operates on one subscription.
Metrics on how each Order Action changes MRR, TCB, and Quantity.
See Orders Object Model for more information.
If you are an existing Zuora’s Subscribe and Amend customer and want to adopt Orders, see Orders Harmonization.
Common Use Cases
Create a New Subscription
Customers want to subscribe to your products in a new subscription.
See Create a Subscription for a tutorial.
Customers want to remove products and subscribe to your other products on the existing subscription.
For example, your customer subscribes to your Service A. But later the customer wants to replace the Service A with your Service B. You can do the subscription changes in one order. First, create a Remove Product action to remove Service A from the subscription. Then create an Add Product action to add Service B to the subscription.
See Replace a Product in a Subscription for a tutorial.
Subscription Renewal with Products Upgrade or Downgrade
Customers want to upgrade or downgrade the products when renewing subscriptions.
For example, your customer subscribes to your Basic Services for a year. Later the customer wants to renew the subscription and upgrades the service to the Premium Services. You can do the subscription changes in one order. First, create a Renew Subscription action to renew the subscription. Then create a Remove Product action to remove Basic Services from the subscription. Finally, create an Add Product action to add the Premium Services to the subscription.
See Renew a Subscription and Upgrade a Product for a tutorial.
A ramp deal is a multi-year deal in which products can vary in price, quantity, discount over different ramp intervals (time-based periods) or can remain flat for the entire duration of the subscription term. Once the Ramps feature is enabled, you can create and manage a ramp deal with native Ramps and report Ramp Metrics.
See the Orders API documentation for the new REST API operations that are available with Orders.
Order metrics are delta values representing the changes in key subscription metrics as a result of order actions. Metrics are tied to each Order Action that generates them, which are then linked to Orders. If there is no change in subscription metrics, an Order Action will not generate order metrics.
For more information about metrics for orders, see Key Metrics for Orders.
Retrieve Order Metrics
You can retrieve metrics for orders through REST API operations:
- Get subscription by key
- Get subscriptions by account
- Get subscriptions by key and version
- Get all orders
- Get an order
- Get orders by invoice owner
- Get orders by subscription owner
- Get orders by subscription number
- Get order metrics for evergreen subscription
- Order Data Source
- Order Action Data Source
- Order Mrr Data Source
- Order Tcb Data Source
- Order Tcv Data Source
- Order Quantity Data Source
The following information is for the existing Zuora Subscribe and Amend customers who have enabled Order Metrics only (not full Orders).
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.
If you are an existing Subscribe and Amend customers who have enabled Order Metrics only, an order is auto-generated when you do any of the following operations.
- Create active subscriptions (UI, REST API, and SOAP API)
- Update subscriptions from the Draft or Pending status to the Active status (UI and SOAP API)
- Create subscription amendments that are in the Complete status (UI, REST API, and SOAP API)
- Update subscription amendments from the Draft or Pending status to the Complete status (UI and SOAP API)
Note that if you do the above operations with the unsupported conditions, the orders will not be generated. See Known Limitations in Orders and Order Metrics.
Orders data is not generated for draft, pending, or deleted Subscriptions and Amendments.
Also note that as part of the Order Metrics migration, a new Amendment Type of "Composite" will appear in the Subscription to represent the Subscription creation.
The table below lists the features you will get from Order Metrics and Orders individually.
|Area||Features||Order Metrics||Full Orders|
|Zuora Central||View the new metrics (the Order metrics) in data sources and reporting|
|Zuora Central||Access Orders data via REST APIs|
|Zuora Central||Estimate the Order metrics for evergreen subscriptions|
|Zuora Central||Break down billing by Order|
|Zuora Central||Create multi-action Orders|
|Zuora CPQ||Create ramp deals natively|
|Zuora CPQ||Access the new quote metrics enabled by Orders|
|Zuora CPQ||Add much more changes in a single Quote|
- (check mark): Zuora supports the feature.