ls_list_subscriptions
Read-onlyIdempotent
List subscriptions filtered by store, order, product, variant, or status. Get paginated results with page metadata for total and navigation.
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.
Tool call template
This tool declares no required parameters. Add optional parameters from the input schema as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {},
"name": "ls_list_subscriptions"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| status | No | Filter by subscription status | |
| include | No | Comma-separated related resources to include (e.g. 'store,customer,order,order-item,product,variant') | |
| orderId | No | Filter by order ID | |
| storeId | No | Filter by store ID | |
| pageSize | No | Results per page (1-100) | |
| productId | No | Filter by product ID | |
| userEmail | No | Filter by user email | |
| variantId | No | Filter by variant ID | |
| pageNumber | No | Page number (1-indexed) | |
| orderItemId | No | Filter by order item ID |