GET /orders

The device from which the customer has made the request

If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.

The email address of your customer/user. Use this when the email address has only ASCII characters.

The IP address of the customer where the request originated

The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.

optional, boolean filter

Order is resent order or not. Possible values are : true, false

Supported operators : is

Example → is_resent[is] = "false"

optional, timestamp(UTC) in seconds filter

This is the date on which the order will be delivered to the customer. Supported operators : after, before, on, between

Example → shipping_date[after] = "1435054328"

optional, timestamp(UTC) in seconds filter

The time at which the order was shipped. Supported operators : after, before, on, between

Example → shipped_at[before] = "1435054328"

optional, enumerated string filter

Resent order status. Possible values are : fully_resent, partially_resent.

Supported operators : is, is_not, in, not_in

Example → resent_status[is] = "fully_resent"

optional, enumerated string filter

The status of this order. Possible values are : new, processing, complete, cancelled, voided, queued, awaiting_shipment, on_hold, delivered, shipped, partially_delivered, returned.

Supported operators : is, is_not, in, not_in

Example → status[is] = "queued"

optional, string filter

If resent order what is the parent order id. Supported operators : is, is_not, starts_with

Example → original_order_id[is] = "1xRt6ifdr"

Flag to indicate whether deleted credit notes should be passed or not.

If set to true, includes the deleted resources in the response. For the deleted resources in the response, the '\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\*\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\*deleted\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\*\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\* ' attribute will be '\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\*\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\*true\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\*\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\* '.

Default value: false

optional, timestamp(UTC) in seconds filter

To filter based on updated at . Supported operators : after, before, on, between

Example → updated_at[on] = "1243545465"

optional, string filter

Uniquely identifies the order. It is the api identifier for the order. Supported operators : is, is_not, starts_with, in, not_in

Example → id[is] = "890"

optional, timestamp(UTC) in seconds filter

The timestamp indicating the date & time the order's invoice got paid. Supported operators : after, before, on, between

Example → paid_on[on] = "1435054328"

The number of resources to be returned.

Default value: 10

optional, string filter

The invoice number which acts as an identifier for invoice and is generated sequentially. Supported operators : is, is_not, starts_with, in, not_in

Example → invoice_id[is] = "INVOICE_982"

optional, enumerated string filter

Order type. Possible values are : manual, system_generated.

Supported operators : is, is_not, in, not_in

Example → order_type[is_not] = "system_generated"

optional, timestamp(UTC) in seconds filter

The date on which the order will start getting processed. Supported operators : after, before, on, between

Example → order_date[before] = "1435054328"

optional, timestamp(UTC) in seconds filter

The time at which the order was created. Supported operators : after, before, on, between

Example → created_at[after] = "1435054328"

optional, string filter

Sorts based on the specified attribute. Supported attributes : created_at, updated_at

Supported sort-orders : asc, desc

Example → sort_by[asc] = "created_at"

This will sort the result based on the 'created_at' attribute in ascending(earliest first) order.

Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set offset to the value of next_offset obtained in the previous iteration of the API call.

optional, string filter

The subscription for which the order is created. Supported operators : is, is_not, starts_with

Example → subscription_id[is_not] = "null"