Use Orders API
This article explains how to use the Orders API to create and manage subscriptions, and understand the differences between the Orders API and the Subscribe and Amend APIs.
After enabling Orders Harmonization, you can use the Orders API to create and manage subscriptions.
Subscribe and Amend API and using Orders API for your common use cases:Subscribe and Amend APIs | Orders API |
|---|---|
Create a subscription Previously, you would use one of the following API functions:
| Use the Create order operation instead. See Create a Subscription . |
Renew a subscription Previously, you would use one of the following API functions:
| Use the Create order operation instead. See Renew a Subscription . |
Cancel a subscription Previously, you would use one of the following API functions:
| Use the Create order operation instead. See Cancel a Subscription . |
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 . |
Suspend and resume a subscription Previously, you would use the following API functions:
| Use the Create order operation instead. See Orders Tutorials . |
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. |
In addition, there are behavior differences between Subscribe and Amend APIs, and the Orders API. See the following table for a behavior difference summary:
| Subscribe and Amend APIs | Orders API |
|---|---|
When creating a subscription using the Create a subscription operation, the runBilling field defaults to true. | When creating a subscription using the Create an order operation, the runBilling field defaults to false. |
When adding a product to a subscription, the billCycleType field of the rate plan charge can be one of the following values:
billCycleDay field of the charge based on the billCycleType value. For example, if billingCycleType is set to DefaultFromCustomer, the system checks the BCD on the account and populates the account's BCD value to the rate plan charge. Hence, billCycelDay of the rate plan charge cannot be null. | When adding a product to a subscription, the billCycleType field of the rate plan charge can be one of the following values:
The system populates the Hence, |