payments_create_coupon
Create a coupon for GoHighLevel payments by specifying name, code, discount type and value, start date, and optional usage limits, end date, or subscription applicability.
Instructions
Create Coupon
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| code | Yes | Coupon Code | |
| name | Yes | Coupon Name | |
| altId | No | Location Id Defaults to GHL_LOCATION_ID when omitted. | |
| altType | No | Alt Type Defaults to GHL_LOCATION_ID when omitted. | |
| endDate | No | End date in YYYY-MM-DDTHH:mm:ssZ format | |
| startDate | Yes | Start date in YYYY-MM-DDTHH:mm:ssZ format | |
| productIds | No | Product Ids | |
| usageLimit | No | Max number of times coupon can be used | |
| discountType | Yes | Discount Type | |
| discountValue | Yes | Discount Value | |
| limitPerCustomer | No | Limits whether a coupon can be redeemed only once per customer. | |
| applyToFuturePayments | No | Is Coupon applicable on upcoming subscription transactions | |
| applyToFuturePaymentsConfig | No | If coupon is applicable on upcoming subscription transactions, how many months should it be applicable for a subscription |