ghl_payment_coupon_delete
Permanently deletes a coupon by ID so checkout links using its code stop applying discounts. Use it to discontinue promotions or clean up unused coupons; this action cannot be undone.
Instructions
Permanently deletes the coupon. Any checkout links relying on its code will stop applying the discount. Delete Coupon The "Delete Coupon" API allows you to permanently remove a coupon from your system using its unique identifier. Use this endpoint to discontinue promotional offers or clean up unused coupons. Note that this action cannot be undone. Endpoint: DELETE /payments/coupon (Version header: v3; source: v3/payments-v3.json) Requires a Sub-Account (location) token. OAuth scopes: payments/coupons.write
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": {
"body": "<body>"
},
"name": "ghl_payment_coupon_delete"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Request body (schema carried verbatim from the official OpenAPI spec). |