Skip to main content

AddressListParams

Extends​

Properties​

created_at_max?​

created_at_max?: string

Returns addresses created before the given time.

created_at_min?​

created_at_min?: string

Returns addresses created after the given time.

cursor?​

cursor?: string

next or previous cursor returned by previous list call

Inherited from​

ListParams.cursor

discount_code?​

discount_code?: string

Returns addresses that have the provided discount_code.

discount_id?​

discount_id?: string | number

Returns addresses that have the provided discount_id.

include?​

include?: AddressIncludes[]

Include related data options

is_active?​

is_active?: boolean

Returns active addresses.

limit?​

limit?: number

default is 50, max is 250

Inherited from​

ListParams.limit

sort_by?​

sort_by?: AddressSortBy

sort list by option

Inherited from​

ListParams.sort_by

Generated using typedoc-plugin-markdown and TypeDoc