Skip to main content

Interface: OrderListParams

Extends​

Properties​

address_id?​

optional address_id: string | number

Filter orders by address.

charge_id?​

optional charge_id: string | number

Filter orders by charge.

created_at_max?​

optional created_at_max: string

Show orders created before the given date.

created_at_min?​

optional created_at_min: string

Show orders created after the given date.

cursor?​

optional cursor: string

next or previous cursor returned by previous list call

Inherited from​

ListParams.cursor

external_order_id?​

optional external_order_id: string | number

Filter orders by external_order_id.

has_external_order?​

optional has_external_order: boolean

Filter orders with/without external_order_id.

ids?​

optional ids: (string | number)[]

Filter orders by id.

include?​

optional include: OrderIncludes[]

Include related data options

limit?​

optional limit: number

default is 50, max is 250

Inherited from​

ListParams.limit

purchase_item_id?​

optional purchase_item_id: string | number

Filter orders by subscription or onetime.

scheduled_at_max?​

optional scheduled_at_max: string

Show orders scheduled before the given date.

scheduled_at_min?​

optional scheduled_at_min: string

Show orders scheduled after the given date.

sort_by?​

optional sort_by: OrderSortBy

sort list by option

Inherited from​

ListParams.sort_by

status?​

optional status: OrderStatus

Filter orders by status.

type?​

optional type: OrderType

Filter orders by type.

updated_at_max?​

optional updated_at_max: string

Show orders updated before the given date.

updated_at_min?​

optional updated_at_min: string

Show orders updated after the given date.