Create Coupon
Create a new coupon for the given product or a checkout
Paddle's Create Coupon API supports:
- Creation and management of large groups of coupons
- Flexibility in the type of discounts you can create
- Real-time, on-demand coupon creation
Example Request
The vendor ID identifies your seller account. This can be found in Developer Tools > Authentication.
The vendor auth code is a private API key for authenticating API requests. This key should never be used in client side code or shared publicly. This can be found in Developer Tools > Authentication.
Will be randomly generated if not specified.
Prefix for generated codes. Not valid if coupon_code is specified.
Number of coupons to generate. Not valid if coupon_code is specified.
Description of the coupon. This will be displayed in the Seller Dashboard.
Either product (valid for specified products or subscription plans) or checkout (valid for any checkout).
Comma-separated list of product IDs. Required if coupon_type is product.
Either flat or percentage.
A currency amount (eg. 10.00) if discount_type is flat, or a percentage amount (eg. 10 for 10%) if discount_type is percentage.
The currency must match the balance currency specified in your account here. Required if discount_amount is flat.
Number of times a coupon can be used in a checkout. This will be set to 999,999 by default, if not specified.
The date (in format YYYY-MM-DD) the coupon is valid until. The coupon will expire on the date at 00:00:00 UTC.
If the coupon is used on subscription products, this indicates whether the discount should apply to recurring payments after the initial purchase.
The name of the coupon group this coupon should be assigned to.