Promo Code

A promo code applies a discount to a plan during checkout. Promo codes can be percentage-based or fixed-amount, and can have usage limits and expiration dates.

Example

{
	"amount_off": 6.9,
	"churned_users_only": true,
	"code": "<string>",
	"company": {
		"id": "biz_xxxxxxxxxxxxxx",
		"title": "<string>"
	},
	"created_at": "2023-12-01T05:00:00.401Z",
	"currency": "usd",
	"duration": "forever",
	"existing_memberships_only": true,
	"expires_at": "2023-12-01T05:00:00.401Z",
	"id": "promo_xxxxxxxxxxxx",
	"new_users_only": true,
	"one_per_customer": true,
	"product": {
		"id": "prod_xxxxxxxxxxxxx",
		"title": "Pickaxe Analytics"
	},
	"promo_duration_months": 42,
	"promo_type": "percentage",
	"status": "active",
	"stock": 42,
	"unlimited_stock": true,
	"uses": 42
}

amount_off · 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

churned_users_only · boolean · required

Restricts promo use to only users who have churned from the company before.

code · string | null · required

The specific code used to apply the promo at checkout.

company · object · required

The company for the promo code.

Show child attributes

id · string · required

The unique identifier for the company.

Example: biz_xxxxxxxxxxxxxx

title · string · required

The written name of the company.

created_at · string<date-time> · required

The datetime the promo code was created.

Example: 2023-12-01T05:00:00.401Z

currency · 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

duration · PromoDurations | null · required

The duration of the promo.

Available options: forever, once, repeating

existing_memberships_only · boolean · required

Restricts promo use to only be applied to already purchased memberships.

expires_at · string<date-time> | null · required

The date/time of when the promo expires.

Example: 2023-12-01T05:00:00.401Z

id · string · required

The unique identifier for the promo code.

Example: promo_xxxxxxxxxxxx

new_users_only · boolean · required

Restricts promo use to only users who have never purchased from the company before.

one_per_customer · boolean · required

Restricts promo use to only be applied once per customer.

product · object | null · required

The product this promo code applies to

Show child attributes

id · string · required

The unique identifier for the product.

Example: prod_xxxxxxxxxxxxx

title · string · required

The display name of the product shown to customers on the product page and in search results.

Example: Pickaxe Analytics

promo_duration_months · integer | null · required

The number of months the promo is applied for.

Example: 42

promo_type · PromoTypes · required

The type (% or flat amount) of the promo.

Available options: percentage, flat_amount

status · PromoCodeStatus · required

Indicates if the promo code is live or disabled.

Available options: active, inactive, archived

stock · integer · required

The quantity limit on the number of uses.

Example: 42

unlimited_stock · boolean · required

Whether or not the promo code has unlimited stock.

uses · integer · required

The amount of times the promo codes has been used.

Example: 42