Skip to main content

OnetimeListParams

Extends

Properties

address_id?

address_id?: string | number

Return the onetimes linked to the given address_id.


address_ids?

address_ids?: (string | number)[]

Return the onetimes linked to the given address_ids.


created_at_max?

created_at_max?: string

Return the onetimes created before the given date.


created_at_min?

created_at_min?: string

Return the onetimes created after the given date.


cursor?

cursor?: string

next or previous cursor returned by previous list call

Inherited from

ListParams.cursor


external_variant_id?

external_variant_id?: string | number

Return the onetimes linked to the given external_variant_id


ids?

ids?: (string | number)[]

List of onetime_ids to filter


include_cancelled?

include_cancelled?: boolean

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


limit?

limit?: number

default is 50, max is 250

Inherited from

ListParams.limit


sort_by?

sort_by?: OnetimesSortBy

sort list by option

Inherited from

ListParams.sort_by


updated_at_max?

updated_at_max?: string

Return the onetimes updated before the given date.


updated_at_min?

updated_at_min?: string

Return the onetimes updated after the given date.


Generated using typedoc-plugin-markdown and TypeDoc