Create Promo Code
Creates a promo code for an account. First-party sessions may attach an affiliate.
Authorizations
An Account API key, account-scoped JWT, App API key, or user OAuth token. Prepend the key or token with Bearer, for example Bearer ***************************.
Headers
A unique key that makes this request safe to retry. See Idempotent requests.
255"d9105228-4a08-46b1-8b91-42fed586d383"
Pins the request to a dated API version.
"2026-08-03"
Body
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 percentage, flat_amount Response
promo code created
Account that owns the promo code.
Discount amount. Percentage discounts are represented as a decimal fraction.
Whether the promo code is restricted to churned customers.
Code entered at checkout.
When the promo code was created, as an ISO 8601 timestamp.
Currency used for a fixed-amount discount.
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 "usd"
How long the discount applies.
forever, once, repeating "forever"
Whether the promo code applies only to existing memberships.
When the promo code expires, as an ISO 8601 timestamp.
Promo code ID, prefixed promo_.
Custom key-value metadata stored on the promo code.
Whether the promo code is restricted to new customers.
Whether each customer may redeem the promo code only once.
Product the promo code is restricted to, or null when it is not product-scoped.
Billing intervals the discount applies to.
Whether the discount is percentage-based or a fixed amount.
percentage, flat_amount "percentage"
Promo code lifecycle status.
active, inactive, archived "active"
Maximum uses when stock is limited.
Whether the promo code has no redemption limit.
When the promo code was updated, as an ISO 8601 timestamp.
Memberships that used the promo code.

