Orders Migration Guidance

Knowledge Center > Subscriptions > Orders > Orders Migration Guidance

Orders Migration Guidance

The migration to full Orders is in Limited Availability. We are actively soliciting feedback from a small set of early adopters before releasing as generally available.

This article describes the processes, prerequisites, and workarounds for enabling and upgrading to Order Metrics and Orders. For information on Orders API migration, see Orders API Migration Guidance. For information on Order Metrics and Orders Limitations, see Known Limitations in Orders and Order Metrics.

Orders Enablement Timeline

When the Order Metrics or Orders feature is enabled in your Zuora tenant, your historic Amendment data is automatically migrated with zero downtime and you can continue normal business operations. 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.

Order Metrics Enablement Process

Perform the following steps to enable the Order Metrics feature in your tenant:

  1. Follow the steps listed below to enable the Order Metrics feature in your tenant:

  2. 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.
  3. Submit a request at Zuora Global Support to enable Order Metrics in your API Sandbox tenant.
  4. Your support agent will help you check the most common prerequisites for Order Metrics based on the Limitations in Order Metrics. If applicable, you should use the workarounds as listed in the table below. 
    a Suspend and resume
     

    Suspend and resume amendments are currently not available with Order Metrics. The following lists the steps to workaround Suspend and Resume for Order Metrics:

    1. Pull a report using Rate Plan as the base object.
      • Set Filter = ‘Subscription Version Amendment Type’ is equal to ’Suspend Subscription’.
    2. If you are leveraging any of our suspend/resume-related events in our notification engine, turn these off for the time being.
      • This can be completed in your Billing Settings > Setup Profiles, Notifications & Email Templates. Turn off the events below:
        • AmendmentProcessed | Suspend Subscription
        • AmendmentProcessed | Resume Subscription
        • Key Date(s) | Subscription Suspend Date
        • Key Date(s) | Subscription Resume Date
      • This ensures your customers are not notified when their subscriptions are pseudo-resumed.
    3. Resume all currently suspended subscriptions.
    4. Complete Remove Product amendments for all products with the appropriate Effective Date.
    5. Complete Add Product amendments to re-add all products when the customer is ready to resume service. See the options below:
      • If Resume Date is already known:
        • Create a Terms and Conditions (T&Cs) amendment if you wish to extend the term.
        • Create future-dated Add-Product amendments. Set Amendment Effective Date = Resume Date.
      • If Resume Date is not known:
        • Create T&Cs and Add Product amendments and leave in a Pending or Draft status. Set Amendment Effective Date = null. Enter in Effective Dates later when the Resume Date is known.
        • Create T&Cs and Add Product amendments at a later date when the Resume Date is known.

    Note that if Subscriptions are suspended and Order Metrics are turned on they will be locked in the Suspended status.

    b Cannot change Start Date of the previous term with Renewal Amendment in place

    After Order Metrics is enabled, you cannot change the Start Date of the subscription term via a T&Cs amendment if a Renewal amendment is already in place. Doing so would result in potential gaps in the Order Metrics generated.

    A workaround is to change the term of the subscription via the T&Cs amendment before enabling Order Metrics.

    c 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 Order Metrics, you should remove all subscriptions with Account level discounts completely. 

    d 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.  

  5. 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.

  6. New data sources become available with Order Metrics, for example, Order TCB, Order ELP, and Order Item. 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.

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

  8. Now your API Sandbox tenant has Order Metrics enabled. You should test in your tenant with dummy data. Zuora recommends that you run the use cases in Order API Migration Guidance and verify the Order Metrics output.

  9. Following successful Sandbox testing, submit a request at Zuora Global Support to enable Order Metrics in your Production Copy Environment (PCE) tenant if you have purchased one. Note that the Reporting UI is not available in PCE tenants, but data source exports are available. 

  10. As in step 3, your support agent will help you check the limitations checklist for your PCE tenant. You should use the same workarounds as listed in the table in step 3, if necessary.

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

  12. Your PCE tenant now has Order Metrics enabled. You should verify Order Metrics in your PCE tenant with production copy data prior to enabling in Production.

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 Suspend and resume

    Suspend and resume amendments are currently not available with Orders. The following lists the steps to workaround Suspend and Resume for Orders:

    1. Pull a report using Rate Plan as the base object.
      • Set Filter = ‘Subscription Version Amendment Type’ is equal to ’Suspend Subscription’.
    2. If you are leveraging any of our suspend/resume-related events in our notification engine, turn these off for the time being.
      • This can be completed in your Billing Settings > Setup Profiles, Notifications & Email Templates. Turn off the events below:
        • AmendmentProcessed | Suspend Subscription
        • AmendmentProcessed | Resume Subscription
        • Key Date(s) | Subscription Suspend Date
        • Key Date(s) | Subscription Resume Date
      • This ensures your customers are not notified when their subscriptions are pseudo-resumed.
    3. Resume all currently suspended subscriptions.
    4. Complete Remove Product amendments for all products with the appropriate Effective Date.
    5. Complete Add Product amendments to re-add all products when the customer is ready to resume service. See the options below:
      • If Resume Date is already known:
        • Create a T&Cs amendment if you wish to extend the term.
        • Create future-dated Add-Product amendments. Set Amendment Effective Date = Resume Date.
      • If Resume Date is not known:
        • Create T&Cs and Add Product amendments and leave in a Pending or Draft status. Set Amendment Effective Date = null. Enter in Effective Dates later when the Resume Date is known.
        • Create T&Cs and Add Product amendments at a later date when the Resume Date is known.

    Note that if Subscriptions are Suspended and Orders is turned on they will be locked in Suspended Status.

    b Cannot change Start Date of the previous term with Renewal Amendment in place

    After Orders is enabled, you cannot change the Start Date of the subscription term via a T&Cs amendment if a Renewal amendment is already in place. Doing so would result in potential gaps in the Order Metrics generated.

    A workaround is to change the term of the subscription via the T&Cs amendment before enabling Orders.

    c 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. 

    d 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.  

    e 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. 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.

  7. 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).

  8. 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.

  9. New Orders Notifications will be enabled for Orders to replace the Amendment and Subscribe notifications. Since notifications for Subscribe and Amend will stop, you should change any applicable integrations to use the new Orders notifications.

  10. 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.

  11. New data sources become available with Order Metrics, for example, Order TCB, Order ELP, and Order Item. 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.

  12. 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. 

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

  14. 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.

  15. 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. 

  16. 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.

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

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

Last modified

Tags

This page has no custom tags.

Classifications

(not set)