List a listing's coupon codes
list_couponsRead-only
One of the user's listings' coupon codes, newest first: what each takes off a buyer's first
purchase and their subscription to its updates, which plans it's for, its limits, how many
buyers have used it (redemption_count), and whether it still works (active?).
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"input": "<input>",
"context": "<context>"
},
"name": "list_coupons"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| sort | No | ||
| input | Yes | ||
| limit | No | The maximum number of records to return | |
| filter | No | A filter to apply to the query: either a condition {"field": ..., "operator": ..., "value": ...} or an {"and": [...]} / {"or": [...]} group of conditions and groups (nestable). Operators: contains, eq, greater_than, greater_than_or_equal, ilike, in, is_distinct_from, is_nil, is_not_distinct_from, less_than, less_than_or_equal, like, not_eq, string_ends_with, string_starts_with. For 'is_nil' the value is true or false; for 'in' the value is an array. Fields: id, code, purchase_percent_off, subscription_percent_off, subscription_periods, base_plan_eligible, plan_ids, max_redemptions, expires_at, discontinued_at, inserted_at, updated_at, listing_id, redemption_count, active?, prices. | |
| offset | No | The number of records to skip | |
| context | Yes | Explain in 15-25 words, in third person, why this tool is called and how it supports the user's goal. For analytics only. Never include personal data, such as names, email addresses or message text; refer to people by role, such as "the user" or "a buyer". | |
| result_type | No | The type of result to return | run_query |