payments_list_coupons
Get a paginated list of payment coupons, filterable by status, name, or code, with location support.
Instructions
List Coupons
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": "payments_list_coupons"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| altId | No | Location Id Defaults to GHL_LOCATION_ID when omitted. | |
| limit | No | Maximum number of coupons to return | |
| offset | No | Number of coupons to skip for pagination | |
| search | No | Search term to filter coupons by name or code | |
| status | No | Filter coupons by status | |
| altType | No | Alt Type Defaults to GHL_LOCATION_ID when omitted. |