Skip to main content

Interface: AddressListParams

Extends​

Properties​

created_at_max?​

optional created_at_max: string

Returns addresses created before the given time.

created_at_min?​

optional created_at_min: string

Returns addresses created after the given time.

cursor?​

optional cursor: string

next or previous cursor returned by previous list call

Inherited from​

ListParams.cursor

discount_code?​

optional discount_code: string

Returns addresses that have the provided discount_code.

discount_id?​

optional discount_id: string | number

Returns addresses that have the provided discount_id.

ids?​

optional ids: string[]

Returns addresses with the provided ids

include?​

optional include: AddressIncludes[]

Include related data options

is_active?​

optional is_active: boolean

Returns active addresses.

limit?​

optional limit: number

default is 50, max is 250

Inherited from​

ListParams.limit

sort_by?​

optional sort_by: AddressSortBy

sort list by option

Inherited from​

ListParams.sort_by