Note: This operation is only available if you have the Orders feature enabled. If you are an existing Zuora Subscribe and Amend customer, we recommend you enable Orders Harmonization to access the Orders feature. With Orders, you can access both existing functions for subscription and billing management and the new features on Zuora Billing.
Note: The Order Line Items feature is now generally available to all Zuora customers. You need to enable the Orders feature to access the Order Line Items feature. As of Zuora Billing Release 313 (November 2021), new customers who onboard on Orders will have the Order Line Items feature enabled by default.
You can use this operation to create subscriptions and make changes to subscriptions by creating orders. You can also use this operation to create order line items by creating orders. The following tutorials demonstrate how to use this operation:
You can also use this operation to create orders and save the orders as Scheduled Orders.
In addition, you can use this operation to place a standalone order to subscribe without pre-defining a product catalog in Zuora Billing. For more information, see Create a subscription using a standalone order. The Standalone Orders feature is in the Early Adopter phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. If you want to join this early adopter program, submit a request at Zuora Global Support.
Note: If you received a timeout error message when creating an order, the call is still running in the backend and the order will be created.
The limit of orders allowed on a subscription is 1000.
The limit of order line items allowed in an order is 100.
Zuora has the following limits on the Orders synchronous API to prevent performance degradation:
If you have an Order that exceeds any limits of the above, Zuora recommends you use the following asynchronous API operations:
Zuora has the following limits on the Orders asynchronous API operations to prevent performance degradation:
Note: When you are to suspend a subcription (via the suspend
order action), if in the same "Create an order" call you are to perform other subsequent order actions on the supscription to suspend, you must first resume the subscription (via a resume
order action).
Note: When using this operation to create an account, create a subscription, run billing, and collect payment in a single call, if any error occurs during the call, such as a payment processing failure and a tax engine failure, then all the other steps will be rolled back. This means that the invoice will not be generated, the subscription will not be created, and the account will not be created.
Note: The characters #
, ?
, and /
are not allowed in the Orders operations.
Idempotency-Key | string <= 255 characters Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. With this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. |
Accept-Encoding | string Include the If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a |
Content-Encoding | string Include the |
Authorization | string The value is in the |
Zuora-Track-Id | string <= 64 characters A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
Zuora-Entity-Ids | string An entity ID. If you have Zuora Multi-entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header. |
Zuora-Org-Ids | string Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs. |
zuora-version | string The minor API version. For a list of available minor versions, see API upgrades. |
category | string Default: "NewSales" Category of the order to indicate a product sale or return. Default value is |
object (orderFieldsCustom) Container for custom fields of an Order object. | |
description | string <= 500 characters A description of the order. |
existingAccountNumber | string <= 70 characters The account number that this order will be created under. Note that this actually specifies the invoice owner account of the subscriptions included in this order. |
externallyManagedBy | string An enum field on the Subscription object to indicate the name of a third-party store. This field is used to represent subscriptions created through third-party stores. |
object (CreateOrderNewAccount) The information of the new account to be created with the order. Note that this actually specifies the invoice owner account of the subscriptions included in this order. To create the new account, either a creditCard structure or the hpmCreditCardPaymentMethodId field (but not both) should be provided. The one provided becomes the default payment method for this account. If the credit card information is declined or can't be verified, then the account is not created. | |
orderDate required | string <date> The date when the order is signed. All the order actions under this order will use this order date as the contract effective date if the contract effective date field is skipped or its value is left as null. |
Array of objects (CreateOrderOrderLineItem) Order Line Items are non subscription based items created by an Order, representing transactional charges such as one-time fees, physical goods, or professional service charges that are not sold as subscription services. With the Order Line Items feature enabled, you can now launch non-subscription and unified monetization business models in Zuora, in addition to subscription business models. Note: The Order Line Items feature is now generally available to all Zuora customers. You need to enable the Orders feature to access the Order Line Items feature. As of Zuora Billing Release 313 (November 2021), new customers who onboard on Orders will have the Order Line Items feature enabled by default. | |
orderNumber | string <= 100 characters The order number of the new order. If not provided, system will auto-generate a number for this order. |
object (processingOptionsOrdersWithDelayedCapturePayment) The container for billing processing options and payment processing options. Note:
| |
reasonCode | string <= 255 characters Values of reason code configured in Billing Settings > Configure Reason Codes through Zuora UI. Indicates the reason when a return order line item occurs. |
object Information of scheduled order. | |
status | string The status of the order. The default value is
|
Array of objects Each item includes a set of order actions, which will be applied to the same base subscription.
When you create an order that includes changes to multiple existing subscriptions, these subscriptions can have different invoice owner accounts. However, creating multiple new subscriptions through the |
Internal Server Error
Request Errors
{- "existingAccountNumber": "A00000097",
- "orderDate": "2024-07-01",
- "subscriptions": [
- {
- "orderActions": [
- {
- "type": "CreateSubscription",
- "createSubscription": {
- "terms": {
- "initialTerm": {
- "period": 12,
- "periodType": "Month",
- "termType": "TERMED"
}, - "renewalSetting": "RENEW_WITH_SPECIFIC_TERM",
- "renewalTerms": {
- "period": 12,
- "periodType": "Month"
}
}, - "subscribeToRatePlans": [
- {
- "productRatePlanId": "8ad081dd9096ef9501909b40bb4e74a4"
}
]
}
}
]
}
]
}
{- "success": true,
- "orderNumber": "O-00000354",
- "accountNumber": "A00000097",
- "status": "Completed",
- "subscriptionNumbers": [
- "A-S00000129"
]
}