Orders API Migration Guidance

Knowledge Center > Subscriptions > Orders > Orders API Migration Guidance

Orders API 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.

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. For more information on Orders migration, see Orders Migration Guidance.

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 and Order Metrics for additional limitations that apply when the Orders feature is enabled.

SOAP API Functions Replaced by Orders

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)