Orders > Subscriptions > subscriptionsPage
Commerce APIOrdersSubscriptionssubscriptionsPage
subscriptionsPage
GET:subscriptions/page.json

Description

Get all existing subscriptions.

See also: Pagination.

Permission bit: "subscriptions.read"

Topic: Subscriptions

Arguments

customer_id: String

Filter output by customer


last_key: String

Key of the last item from previous page. See also: Pagination


limit: Int

Return up to N entries (pagination). See also: Pagination


offset: Int

Skip N entries (pagination). See also: Pagination


shop_id: String!

Unique shop identifier. See also: Unique Identifiers

Example: "sh_EQzGqWoY"


sort_by: SubscriptionsPageSortBy

Whether to sort output in some specific way. See also: Pagination


sort_desc: Boolean

Whether to use descending sort order. See also: Pagination


Result

SubscriptionPage

Preview (typescript)

Loading module