Skip to main content
GET
TypeScript

Autorizaciones

Authorization
string
header
requerido

An Account API key, an App API key, an account access token, an account-scoped user token, or a user OAuth token. Prepend the key or token with Bearer, for example Bearer ***************************. See Auth & API keys for how to get each one.

Scopes

promo_code:basic:read

Encabezados

Api-Version-Date
string

Pins the request to a dated API version.

Ejemplo:

"2026-11-17"

Parámetros de ruta

id
string
requerido

Promo code ID (promo_ tag).

Respuesta

promo code retrieved

account
object
requerido

Account that owns the promo code.

affiliate
object | null
requerido

Affiliate credited with referrals that use the promo code, or null when no affiliate is attached.

amount_off
number
requerido

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

Ejemplo:

0.25

churned_users_only
boolean
requerido

Whether the promo code is restricted to churned customers.

Ejemplo:

false

code
string | null
requerido

Code entered at checkout.

Ejemplo:

"affiliate25"

created_at
string
requerido

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

Ejemplo:

"2026-01-01T12:00:00.000Z"

currency
enum<string>
requerido

Currency used for a fixed-amount discount.

Opciones disponibles:
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,
hnl
Ejemplo:

"usd"

duration
enum<string>
requerido

How long the discount applies.

Opciones disponibles:
forever,
once,
repeating
Ejemplo:

"repeating"

existing_memberships_only
boolean
requerido

Whether the promo code applies only to existing memberships.

Ejemplo:

false

expires_at
string | null
requerido

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

Ejemplo:

"2026-01-01T12:00:00.000Z"

id
string
requerido

Promo code ID, prefixed promo_.

Ejemplo:

"promo_xxxxxxxxxxxxxx"

metadata
object
requerido

Custom key-value metadata stored on the promo code.

Ejemplo:
new_users_only
boolean
requerido

Whether the promo code is restricted to new customers.

Ejemplo:

true

one_per_customer
boolean
requerido

Whether each customer may redeem the promo code only once.

Ejemplo:

true

product
object | null
requerido

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

promo_duration_months
integer | null
requerido

Billing intervals the discount applies to.

Ejemplo:

3

promo_type
enum<string>
requerido

Whether the discount is percentage-based or a fixed amount.

Opciones disponibles:
percentage,
flat_amount
Ejemplo:

"percentage"

status
enum<string>
requerido

Promo code lifecycle status.

Opciones disponibles:
active,
inactive,
archived
Ejemplo:

"active"

stock
integer
requerido

Maximum uses when stock is limited.

Ejemplo:

200

unlimited_stock
boolean
requerido

Whether the promo code has no redemption limit.

Ejemplo:

false

updated_at
string
requerido

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

Ejemplo:

"2026-01-01T12:00:00.000Z"

uses
integer
requerido

Memberships that used the promo code.

Ejemplo:

0