Knowledge Center

Knowledge Center > Subscriptions > Orders > Orders Migration Guidance

Orders Migration Guidance

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.

When the Orders feature is enabled in your Zuora tenant, your historic data are automatically migrated. If you have a large number of subscriptions, the migration can take from a couple of hours up to over a day. You should plan this migration during a low activity time.

The Orders feature provides replacements for several API functions. You must migrate your integrations to use the new REST API operations that are available with Orders. Additionally, some API functions are not available when the Orders feature is enabled. This article lists the affected API functions and provides migration guidance where possible.

REST API Functions Replaced by Orders

The following REST API functions are replaced when the Orders feature is enabled:

Function REST API Changes

Create a subscription

The following operations are affected:

See Create a Subscription for migration guidance.

Renew a subscription

The following operations are affected:

See Renew a Subscription for migration guidance.

Cancel a subscription

The following operations are affected:

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

Update custom fields of a subscription

The following operations are affected:

See Orders Tutorials for migration guidance.

To update custom fields of a subscription, use the "Update subscription custom fields" operation instead.

Preview a subscription

The following operations are affected:

Use the "Preview order" operation instead.

REST API Functions Restricted by Orders

The following REST API functions are not available when the Orders feature is enabled:

Function REST API Restrictions

Suspend or resume a subscription

The following operations are disabled:

Modify or delete a Subscription object

The following operations are disabled:

Modify or delete an Amendment object

The following operations are disabled:

Additional Limitations

See Known Limitations in Orders for additional limitations that apply when the Orders feature is enabled.

Migrating from the SOAP API

When the Orders feature is enabled, the SOAP API is not available. You must migrate any SOAP integrations to use the REST API instead.

You can use the following tutorials to learn how to migrate SOAP calls:

Last modified

Tags

This page has no custom tags.

Classifications

(not set)