Skip to main content

Interface: SubscriptionListParams

Extends​

Properties​

address_id?​

optional address_id?: string | number

Return the subscriptions linked to the given address_id.

address_ids?​

optional address_ids?: (string | number)[]

Return the subscriptions linked to the given address_ids.

bundles_only?​

optional bundles_only?: true

Return only the subscriptions on an active, published bundle. Only true is accepted; omit the field to list all subscriptions.

created_at_max?​

optional created_at_max?: string

Return the subscriptions created before the given date.

created_at_min?​

optional created_at_min?: string

Return the subscriptions 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

Return the subscriptions linked to the given external_variant_id

ids?​

optional ids?: (string | number)[]

List of subscription_ids to filter

include?​

optional include?: SubscriptionIncludes[]

Include related data options

limit?​

optional limit?: number

default is 50, max is 250

Inherited from​

ListParams.limit

sort_by?​

optional sort_by?: SubscriptionSortBy

sort list by option

Inherited from​

ListParams.sort_by

status?​

optional status?: SubscriptionStatus

Return the subscriptions with specified status.

updated_at_max?​

optional updated_at_max?: string

Return the subscriptions updated before the given date.

updated_at_min?​

optional updated_at_min?: string

Return the subscriptions updated after the given date.