Sign in
Orders

List orders of a subscription owner

Note: This feature is only available if you have the Order Metrics feature enabled. As of Zuora Billing Release 284, Orders is generally available and the Order Metrics feature is no longer available as a standalone feature. If you are an existing Subscribe and Amend customer and want Order Metrics only, you must turn on Orders Harmonization. You can still keep the existing Subscribe and Amend API integrations to create and manage subscriptions.

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.

Retrieves the detailed information about all orders for a specified subscription owner. Any orders containing the changes on the subscriptions owned by this account are returned.

Note: You cannot retrieve detailed information about draft orders or scheduled orders through this operation.

get/v1/orders/subscriptionOwner/{accountNumber}

Path parameters

accountNumberstring string required

The subscription owner account number.

Query parameters

pageinteger

The index number of the page that you want to retrieve. This parameter is dependent on pageSize. You must set pageSize before specifying page. For example, if you set pageSize to 20 and page to 2, the 21st to 40th records are returned in the response.

pageSizeinteger

The number of records returned per page in the response.

dateFilterOptionstring

The date type to filter on. This field value can be 'orderDate' or 'updatedDate'. Default is orderDate.

startDatestring date

The result will only contain the orders with the date of 'dateFilterOption' later than or equal to this date.

endDatestring date

The result will only contain the orders with the date of 'dateFilterOption' earlier than or equal to this date.

Headers

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.

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.

nextPagestring URL

URL to retrieve the next page of the response if it exists; otherwise absent.

Changes

Changed in 1 of the 4 revisions of this API.66

  • 702f3caf398566See the full diff
    • ●

      removed the optional property allOf[subschema #2]/orders/items/subscriptions/items/orderActions/items/ownerTransfer/billToContact/allOf[subschema #1: Contact]/allOf[subschema #1: Contact]/zipCode from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property allOf[subschema #2]/orders/items/subscriptions/items/orderActions/items/ownerTransfer/shipToContact/allOf[subschema #1: Contact]/allOf[subschema #1: Contact]/zipCode from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property allOf[subschema #2]/orders/items/subscriptions/items/orderActions/items/ownerTransfer/soldToContact/allOf[subschema #1: Contact]/allOf[subschema #1: Contact]/zipCode from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property allOf[subschema #2]/orders/items/subscriptions/items/orderActions/items/renewSubscription/billToContact/allOf[subschema #1: Contact]/allOf[subschema #1: Contact]/zipCode from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property allOf[subschema #2]/orders/items/subscriptions/items/orderActions/items/renewSubscription/shipToContact/allOf[subschema #1: Contact]/allOf[subschema #1: Contact]/zipCode from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property allOf[subschema #2]/orders/items/subscriptions/items/orderActions/items/renewSubscription/soldToContact/allOf[subschema #1: Contact]/allOf[subschema #1: Contact]/zipCode from the response with the 200 status

      response-optional-property-removed

    • ○

      added the optional property allOf[subschema #2]/orders/items/subscriptions/items/orderActions/items/ownerTransfer/billToContact/allOf[subschema #1: Contact]/allOf[subschema #1: Contact]/postalCode to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property allOf[subschema #2]/orders/items/subscriptions/items/orderActions/items/ownerTransfer/shipToContact/allOf[subschema #1: Contact]/allOf[subschema #1: Contact]/postalCode to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property allOf[subschema #2]/orders/items/subscriptions/items/orderActions/items/ownerTransfer/soldToContact/allOf[subschema #1: Contact]/allOf[subschema #1: Contact]/postalCode to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property allOf[subschema #2]/orders/items/subscriptions/items/orderActions/items/renewSubscription/billToContact/allOf[subschema #1: Contact]/allOf[subschema #1: Contact]/postalCode to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property allOf[subschema #2]/orders/items/subscriptions/items/orderActions/items/renewSubscription/shipToContact/allOf[subschema #1: Contact]/allOf[subschema #1: Contact]/postalCode to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property allOf[subschema #2]/orders/items/subscriptions/items/orderActions/items/renewSubscription/soldToContact/allOf[subschema #1: Contact]/allOf[subschema #1: Contact]/postalCode to the response with the 200 status

      response-optional-property-added