Orders API Migration Guidance

Knowledge Center > Subscriptions > Orders > Orders API Migration Guidance

Orders API Migration Guidance

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

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 impacted API functions and provides migration guidance where possible. For more information on Orders migration, see Orders Migration Guidance.

API Functions Impacted by Orders

The following table lists the Zuora API functions that are not available when the Orders feature is enabled.

Category Impacted 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

Orders Replacements for Impacted REST API Functions

The following table lists the Orders replacements for the impacted REST API functions:

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.

Create a ramp deal See Create a Ramp Deal.

Orders Replacements for Impacted SOAP API Functions

When the Orders feature is enabled, the subscribe() and amend() calls are not available. Additionally, the create(), query(), delete(), and update() calls are disabled for amendments. You must migrate any SOAP integrations using these SOAP calls to use the REST API instead. During the migration, you must specify account numbers instead of account IDs and specify subscription numbers instead of subscription IDs.

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)