ghl_payment_coupon_get
Retrieve coupon details by ID or promotional code to view usage statistics, validity periods, and other payment promotion data for a location.
Instructions
Fetch Coupon The "Get Coupon Details" API enables you to retrieve comprehensive information about a specific coupon using either its unique identifier or promotional code. Use this endpoint to view coupon parameters, usage statistics, validity periods, and other promotional details. Endpoint: GET /payments/coupon (Version header: v3; source: v3/payments-v3.json) Requires a Sub-Account (location) token. OAuth scopes: payments/coupons.readonly
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": {
"altId": "<altId>",
"altType": "<altType>",
"id": "<id>",
"code": "<code>"
},
"name": "ghl_payment_coupon_get"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | Coupon id | |
| code | Yes | Coupon code | |
| altId | Yes | Location Id | |
| altType | Yes | Alt Type |