ls_list_subscriptions
Read-onlyIdempotent
Retrieve and filter subscriptions by store, order, product, variant, or status. Paginated results with page metadata.
Instructions
List all subscriptions, optionally filtered by store, order, product, variant, or status. Results are paginated — check meta.page in the response for currentPage, lastPage, and total.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| storeId | No | Filter by store ID | |
| orderId | No | Filter by order ID | |
| orderItemId | No | Filter by order item ID | |
| productId | No | Filter by product ID | |
| variantId | No | Filter by variant ID | |
| userEmail | No | Filter by user email | |
| status | No | Filter by subscription status | |
| include | No | Comma-separated related resources to include (e.g. 'store,customer,order,order-item,product,variant') | |
| pageNumber | No | Page number (1-indexed) | |
| pageSize | No | Results per page (1-100) |