ghl_payment_coupon_list
Retrieve all coupons from your location. Use this endpoint to view promotional offers, discounts, and filter by status or search term.
Instructions
List Coupons The "List Coupons" API allows you to retrieve a list of all coupons available in your location. Use this endpoint to view all promotional offers and special discounts for your customers. Endpoint: GET /payments/coupon/list (Version header: v3; source: v3/payments-v3.json) OAuth scopes: payments/coupons.readonly Pagination params: limit, offset — pass them to page through full result sets.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| altId | Yes | Location Id | |
| 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 | Yes | Alt Type |