Coupon Manager
Create, update, delete, and retrieve discount coupons for products and services with percentage or fixed-amount discounts and usage limits.
The Coupon Manager handles discount codes for GHL storefronts and payment flows. Create percentage or fixed-amount coupons, set usage limits, and manage promotional campaigns programmatically.
What This MCP Tool Does
Full CRUD operations on coupon codes. Create coupons for promotions, update terms and limits, retrieve existing coupons for auditing, and delete expired offers. Coupons apply to products and services at checkout.
Endpoint Reference
Create a coupon:
POST /payments/coupons
Define a new coupon with discount type, amount, and usage parameters.
List all coupons:
GET /payments/coupons
Retrieve all coupons in the sub-account.
Update a coupon:
PUT /payments/coupons/{couponId}
Modify coupon terms, amount, or usage limits.
Delete a coupon:
DELETE /payments/coupons/{couponId}
Remove a coupon permanently.
Authentication
Requires a Private Integration Token (PIT) with the payments scope enabled.
Key Parameters
When creating coupons:
code— the coupon code customers enter (e.g., “SAVE20”)type— discount type:percentageorfixedamount— discount value (percentage as whole number, fixed in smallest currency unit)maxUses— total number of times the coupon can be usedexpiresAt— expiration date
Important Notes
Coupon codes should be unique and memorable. For programmatic promotions (like birthday discounts), generate unique codes per contact to prevent sharing.
Track coupon usage against your limits. A coupon that has reached its maxUses will be rejected at checkout, which can frustrate customers if the promotion is still being advertised.
For agencies running promotions across client accounts, create coupons as part of the campaign setup automation. Clean up expired coupons periodically to keep the coupon list manageable.
Common Questions
Can I create a coupon that only works for specific products? Check the coupon configuration for product scope parameters. Some implementations support product-level restrictions; others apply to the entire cart.
Can I limit a coupon to one use per customer? Usage limits may be global (total uses) or per-customer depending on the configuration options available. Check the endpoint parameters for per-customer limiting.
How do I track how many times a coupon has been used? Retrieve the coupon and check usage count fields in the response. Cross-reference with Transactions for specific orders that used the coupon.
Related MCP Tools
- Product CRUD — Products that coupons apply to
- Price Manager — Coupons discount the configured prices
- Order Manager — Orders that used coupons
- Invoice CRUD — Coupons may apply to invoice line items