List subscriptions
list_subscriptionsRetrieve and filter paginated subscriptions by status, store, product, variant, customer email, order, or account to manage recurring billing records.
Instructions
Returns a paginated list of subscriptions.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | ||
| status | No | Exact native filter value. | |
| account | No | Exact private profile label. Does not prove store ownership; mode applies to the main API key only. | |
| include | No | Comma-separated native relationships from pinned official SDK: store, customer, order, order-item, product, variant, subscription-items, subscription-invoices. | |
| order_id | No | Exact opaque native resource ID; no traversal or URL. | |
| per_page | No | Native page size; default10, max100. | |
| store_id | No | Exact native resource ID. | |
| product_id | No | Exact opaque native resource ID; no traversal or URL. | |
| user_email | No | Exact native filter value. | |
| variant_id | No | Exact opaque native resource ID; no traversal or URL. | |
| order_item_id | No | Exact opaque native resource ID; no traversal or URL. |