Sign in
Orders

Create an order

Note: This operation is only available if you have the Orders feature enabled. If you are an existing Zuora <a href="https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/subscribe-and-amend" target="_blank">Subscribe and Amend</a> customer, we recommend you enable <a href="https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders-harmonization" target="_blank">Orders Harmonization</a> to access the <a href="https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/orders-introduction/overview-of-orders" target="_blank">Orders</a> 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 <a href="https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/orders-introduction/scheduled-orders" target="_blank">Scheduled Orders</a>.

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 <a href="https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders/create-a-subscription-using-a-standalone-order" target="_blank">Create a subscription using a standalone order</a>.

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.

post/v1/orders

Query parameters

returnIdsboolean

Specify whether to return IDs associated with the numbers returned in the "Create an order" operation.

Headers

Idempotency-Keystring

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-Encodingstring

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-Encodingstring

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.

Zuora-Track-Idstring

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-Idsstring

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-Idsstring

Comma separated IDs. If you have <a href="https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org" target="_blank">Zuora Multi-Org</a> 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. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs.

Zuora-Versionstring

The minor API version.

For a list of available minor versions, see API upgrades.

Request body

category'NewSales' | 'Return'

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

customFieldsOrderObjectCustomFields

Container for custom fields of an Order object.

descriptionstring

A description of the order.

existingAccountIdstring

The account ID under which this order will be created. This field sets the default invoice owner account and subscription owner account for any new subscriptions in the order. To override these defaults for individual subscriptions, use the subscriptionOwnerAccountNumber and invoiceOwnerAccountNumber nested fields in the subscriptions field. If you want to relax the restriction that the existingAccountNumber must be the invoice owner of the subscriptions in this order, submit a request to <a href="https://support.zuora.com/" target="_blank">Zuora Global Support</a>.

Note: You can specify either the existingAccountNumber or existingAccountId field, but not both.

existingAccountNumberstring

The account number under which this order will be created. This field sets the default invoice owner account and subscription owner account for any new subscriptions in the order. To override these defaults for individual subscriptions, use the subscriptionOwnerAccountNumber and invoiceOwnerAccountNumber nested fields in the subscriptions field. If you want to relax the restriction that the existingAccountNumber must be the invoice owner of the subscriptions in this order, submit a request to <a href="https://support.zuora.com/" target="_blank">Zuora Global Support</a>.

orderDatestring date required

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.

orderNumberstring

The order number of the new order. If not provided, system will auto-generate a number for this order.
Note: The characters #, ?, and / are not allowed in this field. Additionally, to ensure compatibility with the UI when viewing orders, use only the following special characters: _,-, ., ~, *, (, ), and '.

reasonCodestring

Values of reason code configured in Billing Settings > Configure Reason Codes through Zuora UI. Indicates the reason when a return order line item occurs.

status'Draft' | 'Pending' | 'Completed' | 'Scheduled' | 'Executing' | 'Failed'

The status of the order. The default value is Completed. The following values are supported:

  • Draft: The order is in draft status.
  • Pending: The order is in pending status.
  • Completed: The order is in completed status.
  • Scheduled: The order is in scheduled status and it is only valid if the Scheduled Orders feature is enabled.
  • Executing: The scheduled order is executed by a scheduler and it is only valid if the Scheduled Orders feature is enabled.
  • Failed: The scheduled order has failed.

Note: If you have the Pending Subscription Processing feature turned on and want to create a completed order with an active subscription with pending charges, you must specify Completed in this field because the default order status is Pending for this scenario.

Example request

{
  "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"
              }
            ]
          }
        }
      ]
    }
  ]
}

Response

OK

processIdstring

The ID of the process that handles the operation.

requestIdstring uuid

Unique identifier of the request.

successboolean

Indicates whether the call succeeded.

accountIdstring

The account ID for the order. This field is returned instead of the accountNumber field if the returnIds query parameter is set to true.

accountNumberstring

The account number for the order.

creditMemoIdsstring[]

An array of the credit memo IDs generated in this order request. The credit memo is only available if you have the Invoice Settlement feature enabled. This field is returned instead of the creditMemoNumbers field if the returnIds query parameter is set to true.

creditMemoNumbersstring[]

An array of the credit memo numbers generated in this order request. The credit memo is only available if you have the Invoice Settlement feature enabled.

invoiceIdsstring[]

An array of the invoice IDs generated in this order request. Normally it includes one invoice ID only, but can include multiple items when a subscription was tagged as invoice separately. This field is returned instead of the invoiceNumbers field if the returnIds query parameter is set to true.

invoiceNumbersstring[]

An array of the invoice numbers generated in this order request. Normally it includes one invoice number only, but can include multiple items when a subscription was tagged as invoice separately.

orderIdstring

The ID of the order created. This field is returned instead of the orderNumber field if the returnIds query parameter is set to true.

orderNumberstring

The order number of the order created.

paidAmountstring

The total amount collected in this order request.

paymentIdstring

The payment Id that is collected in this order request. This field is returned instead of the paymentNumber field if the returnIds query parameter is set to true.

paymentNumberstring

The payment number that is collected in this order request.

paymentStatus'Error' | 'Processing' | 'Failed'

Specifies the outcome of payment collection for the order. If collectPayment is true and allowPaymentFailure is true, the order can still succeed even when payment does not, and this field shows the payment result in the response. The possible values are:

  • Error: Payment failed with a gateway decline, while the order, subscription, and invoice were still created successfully when allowPaymentFailure is true.
  • Processing: Payment was still in progress or not finalized in the response example for a simulated payment timeout, while the order succeeded.
  • Failed: Payment failed and the response included paymentErrorCode and paymentErrorMessage, while the order still completed successfully.
status'Draft' | 'Pending' | 'Completed' | 'Scheduled'

Status of the order. Pending is only applicable for an order that contains a CreateSubscription order action.

subscriptionIdsstring[]

Container for the subscription IDs of the subscriptions in an order. This field is returned if the returnIds query parameter is set to true.

Example response

{
  "commitments": [
    {
      "prepaymentType": "FullyPrepaid"
    }
  ],
  "refunds": [
    {
      "number": "R-00009564"
    }
  ],
  "writeOff": [
    {
      "invoiceNumber": "INV00051208"
    }
  ]
}

Changes