Skip to main content

Interface: OnetimeListParams

Extends​

Properties​

address_id?​

optional address_id?: string | number

Return the onetimes linked to the given address_id.

address_ids?​

optional address_ids?: (string | number)[]

Return the onetimes linked to the given address_ids.

created_at_max?​

optional created_at_max?: string

Return the onetimes created before the given date.

created_at_min?​

optional created_at_min?: string

Return the onetimes created after the given date.

cursor?​

optional cursor?: string

next or previous cursor returned by previous list call

Inherited from​

ListParams.cursor

external_variant_id?​

optional external_variant_id?: string | number

Return the onetimes linked to the given external_variant_id

ids?​

optional ids?: (string | number)[]

List of onetime_ids to filter

include?​

optional include?: OnetimeIncludes[]

Include related data options

include_cancelled?​

optional include_cancelled?: boolean

If true the response will include the cancelled Onetimes as well as the others.

limit?​

optional limit?: number

default is 50, max is 250

Inherited from​

ListParams.limit

sort_by?​

optional sort_by?: OnetimesSortBy

sort list by option

Inherited from​

ListParams.sort_by

updated_at_max?​

optional updated_at_max?: string

Return the onetimes updated before the given date.

updated_at_min?​

optional updated_at_min?: string

Return the onetimes updated after the given date.