Promo Code - Whop Docs

A Promo Code is a discount a buyer enters at checkout, either a percentage or a fixed amount off. It belongs to an account, can be limited to one product, and controls who can redeem it, how many times, until when, and for how many billing periods the discount lasts. Use the Promo Codes API to create codes for an account, list and retrieve them, deactivate a code to pause redemptions or activate it again, and archive codes you no longer offer.

Endpoints

Endpoint	Request
List Promo Codes	GET `/promo_codes`
Retrieve Promo Code	GET `/promo_codes/{id}`
Create Promo Code	POST `/promo_codes`
Activate Promo Code	POST `/promo_codes/{id}/activate`
Deactivate Promo Code	POST `/promo_codes/{id}/deactivate`
Delete Promo Code	DELETE `/promo_codes/{id}`

Attributes

string

required

Promo code ID, prefixed promo_.

object

required

Account that owns the promo code.

Properties

string

required

Account ID, prefixed biz_.

string

required

Account display name.

number

required

Discount amount. Percentage discounts are represented as a decimal fraction.

boolean

required

Whether the promo code is restricted to churned customers.

string | null

required

Code entered at checkout.

string

required

When the promo code was created, as an ISO 8601 timestamp.

string

required

Currency used for a fixed-amount discount.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

string

required

How long the discount applies.Available options: forever, once, repeating

boolean

required

Whether the promo code applies only to existing memberships.

string | null

required

When the promo code expires, as an ISO 8601 timestamp.

object

required

Custom key-value metadata stored on the promo code.

boolean

required

Whether the promo code is restricted to new customers.

boolean

required

Whether each customer may redeem the promo code only once.

object | null

required

Product the promo code is restricted to, or null when it is not product-scoped.

Properties

string

required

Product ID, prefixed prod_.

string

required

Product display name.

Billing intervals the discount applies to.

Whether the discount is percentage-based or a fixed amount.Available options: percentage, flat_amount

string

required

Promo code lifecycle status.Available options: active, inactive, archived

integer

required

Maximum uses when stock is limited.

boolean

required

Whether the promo code has no redemption limit.

string

required

When the promo code was updated, as an ISO 8601 timestamp.

integer

required

Memberships that used the promo code.

PromoCode

{
	"id": "promo_xxxxxxxxxxxxxx",
	"code": "SUMMER25",
	"account": {
		"id": "biz_xxxxxxxxxxxxxx",
		"title": "Shine Time Auto Detailing"
	},
	"product": {
		"id": "prod_xxxxxxxxxxxxxx",
		"title": "Ceramic Coating Package"
	},
	"status": "active",
	"promo_type": "percentage",
	"amount_off": 0.25,
	"currency": "usd",
	"duration": "repeating",
	"promo_duration_months": 3,
	"new_users_only": true,
	"churned_users_only": false,
	"existing_memberships_only": false,
	"one_per_customer": true,
	"unlimited_stock": false,
	"stock": 200,
	"uses": 37,
	"expires_at": "2026-12-31T23:59:59.000Z",
	"metadata": {},
	"created_at": "2026-09-01T12:00:00.000Z",
	"updated_at": "2026-09-01T12:00:00.000Z"
}

​Endpoints

​Attributes

Endpoints

Attributes