Skip to main content

Orders Migration Guidance

Zuora

Orders Migration Guidance

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 applies only to Zuora's existing Subscribe and Amend customers who choose to either or both of the following:

  • Migrate your integrations to Orders
  • Migrate your historical Amendment data to Orders

This article describes the processes, prerequisites, and workarounds for enabling and upgrading to Orders. Also, it provides guidance on API migration if you want to migrate your Subscribe and Amend API integrations to use the Orders APIs. For information on Orders Limitations, see Known Limitations in Orders and Order Metrics.

Orders Enablement Process

Perform the following steps to enable the Orders feature in your tenant:

  1. First complete the Zuora University training "Zuora Orders: An Introduction" and "Subscription Management, Order Metrics, and CPQ". This will give you an introduction to Full Orders as well as Order Metrics and other related features. To take this training: 
    • Visit Zuora University. 
    • Enter your Access Code: zuorderupgrade18
    • Enter all other information and click "Sign Up".  
  2. Upgrade your Zuora Quotes to the latest version assuming you have assessed any customization related issues. See Upgrade Zuora Quotes.
  3. Submit a request at Zuora Global Support to enable Orders in your API Sandbox tenant.
  4. Your support agent will help you check the most common prerequisites for Orders based on the Limitations in Orders. If applicable, use the workarounds as listed in the table below. 
    a Account level discounts
     

    Account level discounts are not available with Order Metrics. 

    A workaround is to use Subscription level discounts instead of Account level discounts if you have this business requirement. 

    You can still perform the following Amendments for Subscriptions under an Account with an account level discount applied, but no order metrics will be generated until those subscriptions with Account level discounts are removed:

    • Create Subscription (without an account level discount)
    • Add Product (without an account level discount)
    • Update
    • Remove 
    • T&Cs
    • Cancellation 
    • Renew
    • Suspend / Resume

    Ideally before enabling Orders, you should remove all subscriptions with Account level discounts completely. 

    b Draft/Pending subscriptions and amendments

    You can create Draft/Pending subscriptions, but these pending Subscriptions and Amendments are not migrated and Order Metrics are not generated until all activation dates are provided.

    Before enabling Order Metrics, you should ideally activate or delete all draft and pending subscriptions, though metrics will be generated once activated after enablement.  

    c Subscription product features With Orders enabled, you can still have features related to the product in your tenant, but you cannot change these features when creating your subscription.
  5. Verify your integrations with Zuora and check whether Subscribe/Amend APIs are used. If so, migrate your integrations to use the Orders REST APIs. See Orders API Migration Guidance.

  6. Check your tenant's subscription setting on "Calculate Tax for TCB and ELP Metrics?". If your setting is Yes, Zuora will call the tax engine to populate the Tax fields for TCB metrics during the Orders migration. Zuora recommends that you configure the setting to No before migrating to Orders. Note the Order ELP feature is only available to existing Orders customers who already have access to the feature.

    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.

  7. If your Salesforce org has used Order Builder in Zuora 360, check whether Subscribe/Amend APIs are used in your Order Builder integration code. If yes, migrate your integrations to use the Orders REST APIs.

  8. Verify your Zuora Quotes customizations and check for any usage of the Billing Total, Subtotal, Tax, or Discount fields at Quote Rate Plan Charge or Quote Charge Summary level. As these fields are no longer populated OOTB with Orders, Zuora recommends customization to calculate these fields in conjunction with the Invoice Item Global Methods for any custom Quote PDF presentation requirements such as for Ramp Deals. For non Ramp Deal Quotes, it is advised to consider using the new TCB fields (e.g., Delta TCB, Delta TCB Tax, Delta Discount TCB).

  9. Verify your Zuora Quotes customizations and check whether there is any customization populating forecasting or approval processes. Since the metrics returned by Orders are different, you should change your customization accordingly if needed.

  10. New Orders Notifications will be enabled for Orders. For any subscription creation or amendment created through Subscribe and Amend APIs, the existing Zuora Billing notifications configured in your tenant will continue to work. However, since for every subscription creation and amendment, if you configure Orders notifications then both order related notifications and amendment notifications will be triggered. Zuora recommends you to configure only the Orders notifications and turn off the existing Amendment related notifications if you do not want duplicate notifications.

  11. If your tenant has any data queries (for example, ZOQL or AQuA) or third party data warehouse transformations that depend on amendment data, you should consider refactoring these queries or transformations to use Orders.

  12. New data sources become available with Order Metrics, for example, Order MRR and Order TCB. Since the new data sources can be leveraged by your Revenue Recognition integration (especially for ASC 606 or IFRS 15), you should review your Revenue Recognition processes to determine any impacts or any improvements needed.

  13. Verify any existing in-flight quotes in your Zuora Quotes implementation. Any existing quotes should be able to send to Zuora successfully after enabling Orders (assuming you upgraded from a relatively recent Quotes version such as 8.x). However, if you try to preview Metrics on an existing quote that was created prior to the Orders upgrade, an error may occur. Zuora recommends that you re-create the quote in this case. 

  14. Your support agent will now enable Orders in your API Sandbox tenant. You do not need to take any action in this step.

  15. Now your API Sandbox tenant has Orders enabled. You should test in your tenant with dummy data. Zuora recommends that you run the use cases in Order API Migration Guidance.

  16. Submit a request at Zuora Global Support to enable Orders in your Production Copy Environment (PCE) tenant if you have purchased one. Note that the Reporting UI and Orders UI is not available in PCE tenants, but data source exports are available. 

  17. As for the API Sandbox tenant, your support agent will help you check the limitation checklist for your PCE tenant. You should use the same workarounds as listed in the table in step 4.

  18. Your support agent will now enable Orders in your PCE tenant. You do not need to take any action in this step.

  19. Your PCE tenant now has Orders enabled. You should test your PCE tenant with production copy data prior to enabling in Production.

Migrating Historical Amendment Data

When the Orders feature is enabled in your Zuora tenant, you can choose to migrate your historical amendment data to Orders. 

Based on historical data, about 500K to 1M subscriptions can be migrated per day. However, the actual migration time depends on the subscription size: the number of products and charges in a subscription, and so on. If you have a large number of subscriptions, you should plan this migration during a low activity time, if possible. Note that when performing the data migration for a Production Copy Environment (services environment), the migration can take significantly longer.

Orders API Migration Guidance

This section provides guidance on migrating your Subscribe and Amend API integrations to use the Orders APIs. 

With Orders Harmonization, you can continue to use Subscribe and Amend APIs and also leverage Orders APIs and Orders UI to create and manage your subscriptions. You do not need to go through migration to leverage Orders related functionality. However, if you still want to refactor all of your existing Subscribe and Amend APIs to Orders APIs, you can still do that. 

Subscribe and Amend APIs to Migrate

The following table lists the Zuora Subscribe and Amend APIs that are to be migrated to Orders APIs.

Category Subscribe and Amend API Functions
REST

CRUD REST

SOAP
  • subscribe()
  • amend()
  • create() - cannot be used for amendments
  • query() - cannot be used for amendment
  • delete() - cannot be used for amendment
  • update() - cannot be used for amendment

Subscribe and Amend REST API Migration

If you want to migrate your integrations using the REST calls listed in Subscribe and Amend APIs to Migrate to use the Orders API instead, see the following table for the Orders replacements for the Subscribe and Amend REST APIs and the migration tutorials:

Function Orders Replacements

Create a subscription

Previously, you would use one of the following API functions:

Use the Create order operation instead.

See Create a Subscription for migration guidance.

Renew a subscription

Previously, you would use one of the following API functions:

Use the Create order operation instead.

See Renew a Subscription for migration guidance.

Cancel a subscription

Previously, you would use one of the following API functions:

Use the Create order operation instead.

See Cancel a Subscription for migration guidance.

Add, update, or remove products in a subscription

Change the terms and conditions of a subscription

Transfer ownership of a subscription

Previously, you would use one of the following API functions:

Use the Create order operation instead.

See Orders Tutorials for migration guidance.

 

Suspend and resume a subscription

Previously, you would use the following API functions:

Use the Create order operation instead.

See Orders Tutorials for migration guidance.

Update custom fields of a subscription

Previously, you would use one of the following API functions:

Use the Update subscription custom fields operation instead.

Preview a subscription

Previously, you would use the Preview subscription operation.

 

Use the Preview order operation instead.

Subscribe and Amend SOAP API Migration

If you want to migrate your integrations using the SOAP calls listed in Subscribe and Amend APIs to Migrate to use the Orders API instead, see the following tutorials to learn how to migrate SOAP calls.

During the migration, you must specify account numbers instead of account IDs and specify subscription numbers instead of subscription IDs.