Skip to main content
​
number
required
The discount amount. Interpretation depends on promo_type: if ‘percentage’, this is the percentage (e.g., 20 means 20% off); if ‘flat_amount’, this is dollars off (e.g., 10.00 means $10.00 off).Example: 6.9
​
boolean
required
Restricts promo use to only users who have churned from the company before.
​
string | null
required
The specific code used to apply the promo at checkout.
​
object
required
The company for the promo code.
​
string<date-time>
required
The datetime the promo code was created.Example: 2023-12-01T05:00:00.401Z
​
Currencies
required
The monetary currency of the promo code.Available options: usd, sgd, inr, aud, brl, cad, dkk, eur, nok, gbp, sek, chf, hkd, huf, jpy, mxn, myr, pln, czk, nzd, aed, eth, ape, cop, ron, thb, bgn, idr, dop, php, try, krw, twd, vnd, pkr, clp, uyu, ars, zar, dzd, tnd, mad, kes, kwd, jod, all, xcd, amd, bsd, bhd, bob, bam, khr, crc, xof, egp, etb, gmd, ghs, gtq, gyd, ils, jmd, mop, mga, mur, mdl, mnt, nad, ngn, mkd, omr, pyg, pen, qar, rwf, sar, rsd, lkr, tzs, ttd, uzs, rub, btc, cny, usdt, kzt, awg, whop_usd, xau
​
PromoDurations | null
required
The duration of the promo.Available options: forever, once, repeating
​
boolean
required
Restricts promo use to only be applied to already purchased memberships.
​
string<date-time> | null
required
The date/time of when the promo expires.Example: 2023-12-01T05:00:00.401Z
​
string
required
The unique identifier for the promo code.Example: promo_xxxxxxxxxxxx
​
boolean
required
Restricts promo use to only users who have never purchased from the company before.
​
boolean
required
Restricts promo use to only be applied once per customer.
​
object | null
required
The product this promo code applies to
​
integer | null
required
The number of months the promo is applied for.Example: 42
​
PromoTypes
required
The type (% or flat amount) of the promo.Available options: percentage, flat_amount
​
PromoCodeStatus
required
Indicates if the promo code is live or disabled.Available options: active, inactive, archived
​
integer
required
The quantity limit on the number of uses.Example: 42
​
boolean
required
Whether or not the promo code has unlimited stock.
​
integer
required
The amount of times the promo codes has been used.Example: 42