Create an order asynchronously

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.

In the case where a normal "Create an order" operation call will time out, use this operation instead to create an order asynchronously. A job will be creating the order in the back end; the job ID will be returned for tracking the job status and result.

Note that this operation doesn't support auto-refund and invoice write-off during subscription cancellation. Use the "Create an order" operation instead.

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:

Request
query Parameters
returnIds
boolean
Default: false

Specify whether to return IDs for the Get job status and response operation. If you set this query parameter to true, the corresponding IDs, which are associated with the numbers returned in this operation, can be returned in the "Get job status and response" response body.

header Parameters
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 Accept-Encoding: gzip header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response.

If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a Content-Encoding header with the compression algorithm so that your client can decompress it.

Content-Encoding
string

Include the Content-Encoding: gzip header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload.

Authorization
string

The value is in the Bearer {token} format where {token} is a valid OAuth token generated by calling Create an OAuth token.

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 (:), semicolon (;), double quote ("), and quote (').

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 do not need to 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 version of the Zuora REST API.

You need to set this parameter if you want to use the following fields:

  • subscriptions
  • subscriptionNumbers
  • subscriptionIds (when the returnId query parameter is set to true)
Request Body schema: application/json
category
string
Default: "NewSales"

Category of the order to indicate a product sale or return. Default value is NewSales.

Enum: "NewSales" "Return"
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.

Enum: "Amazon" "Apple" "Google" "Roku"
object (Account)

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.
Note: Make sure the order number does not contain a slash.

object (processingOptionsOrdersAsync)

The container for billing processing options and payment processing options.

Note: This field is not supported in draft orders.

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.

Array of objects

Each item includes a set of order actions, which will be applied to the same base subscription.

Responses
202

Accepted

post/v1/async/orders
Request samples
application/json
{
  • "description": "This is a description for the Order.",
  • "existingAccountNumber": "A00000001",
  • "orderDate": "2017-01-01",
  • "orderLineItems": [
    ],
  • "orderNumber": "OM-00001",
  • "processingOptions": {
    },
  • "subscriptions": [
    ]
}
Response samples
application/json
{
  • "jobId": "1bc24f315d7b48d3a20245bfe73bdceb",
  • "success": "true"
}