Skip to main content

OrderListParams

Extends​

Properties​

address_id?​

address_id?: string | number

Filter orders by address.

charge_id?​

charge_id?: string | number

Filter orders by charge.

created_at_max?​

created_at_max?: string

Show orders created before the given date.

created_at_min?​

created_at_min?: string

Show orders created after the given date.

cursor?​

cursor?: string

next or previous cursor returned by previous list call

Inherited from​

ListParams.cursor

external_order_id?​

external_order_id?: string | number

Filter orders by external_order_id.

has_external_order?​

has_external_order?: boolean

Filter orders with/without external_order_id.

ids?​

ids?: (string | number)[]

Filter orders by id.

include?​

include?: OrderIncludes[]

Include related data options

limit?​

limit?: number

default is 50, max is 250

Inherited from​

ListParams.limit

purchase_item_id?​

purchase_item_id?: string | number

Filter orders by subscription or onetime.

scheduled_at_max?​

scheduled_at_max?: string

Show orders scheduled before the given date.

scheduled_at_min?​

scheduled_at_min?: string

Show orders scheduled after the given date.

sort_by?​

sort_by?: OrderSortBy

sort list by option

Inherited from​

ListParams.sort_by

status?​

status?: OrderStatus

Filter orders by status.

type?​

type?: OrderType

Filter orders by type.

updated_at_max?​

updated_at_max?: string

Show orders updated before the given date.

updated_at_min?​

updated_at_min?: string

Show orders updated after the given date.

Generated using typedoc-plugin-markdown and TypeDoc