API Reference
Overview
Quick Start
API Authentication
API Error Codes
APIs
Checkout API
Checkout API
Order Details
User History
Prices
Product API
Product API
Coupons
List Coupons
post
Create Coupon
post
Delete Coupon
post
Update Coupon
post
Products
Licenses
Pay Links
Transactions
Payments
Subscription API
Subscription API
Plans
Users
Modifiers
Payments
One-off Charges
Alert API
Alert API
Webhooks

Create Coupon

post
/2.1/product/create_coupon

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

preparing...
vendor_id
integer
required

The vendor ID identifies your seller account. This can be found in Developer Tools > Authentication.

>= 1
vendor_auth_code
string
required

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.

Match pattern:
[0-9a-f]+
coupon_code
string

Will be randomly generated if not specified.

>= 5 characters<= 300 characters
coupon_prefix
string

Prefix for generated codes. Not valid if coupon_code is specified.

num_coupons
integer

Number of coupons to generate. Not valid if coupon_code is specified.

description
string

Description of the coupon. This will be displayed in the Seller Dashboard.

<= 300 characters
coupon_type
string
required

Either product (valid for specified products or subscription plans) or checkout (valid for any checkout).

Allowed values:
productcheckout
product_ids
string

Comma-separated list of product IDs. Required if coupon_type is product.

discount_type
string
required

Either flat or percentage.

Allowed values:
flatpercentage
discount_amount
number
required

A currency amount (eg. 10.00) if discount_type is flat, or a percentage amount (eg. 10 for 10%) if discount_type is percentage.

currency
string

The currency must match the balance currency specified in your account here. Required if discount_amount is flat.

Allowed values:
USDGBPEUR
Match pattern:
[A-Z]{3}
allowed_uses
integer

Number of times a coupon can be used in a checkout. This will be set to 999,999 by default, if not specified.

expires
string<date>

The date (in format YYYY-MM-DD) the coupon is valid until. The coupon will expire on the date at 00:00:00 UTC.

Match pattern:
\d{4}-\d{2}-\d{2}
recurring
integer

If the coupon is used on subscription products, this indicates whether the discount should apply to recurring payments after the initial purchase.

Allowed values:
01
group
string

The name of the coupon group this coupon should be assigned to.

>= 1 characters<= 50 characters
Body
:
:
:
:
:
:
:
:
:
:
:
:
:
:
: