Subscribe and REST API Migration
This topic provides guidance on migrating from Subscribe and Amend REST APIs to the Orders API, including replacements and tutorials.
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 or Renew subscription 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 or Cancel subscription 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 , or Suspend subscription and Resume subscription operations 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. |