List Promo Codes

GET

promo_codes

curl --request GET \
  --url https://api.whop.com/api/v2/promo_codes

{
  "pagination": {
    "current_page": 123,
    "total_page": 123,
    "total_count": 123
  },
  "data": [
    {
      "id": "<string>",
      "plans": "<string>",
      "amount_off": 123,
      "base_currency": "usd",
      "code": "<string>",
      "new_users_only": true,
      "number_of_intervals": 123,
      "plan_ids": [
        [
          "<any>"
        ]
      ],
      "promo_type": "percentage",
      "status": "active",
      "stock": 123,
      "unlimited_stock": true,
      "uses": 123,
      "created_at": 123,
      "expiration_datetime": 123,
      "metadata": {},
      "duration": "forever",
      "existing_memberships_only": true
    }
  ]
}

Headers

Authorization

string

Your API key, which can be found on the Whop Business Dashboard. You must prepend your key with the word 'Bearer', which will look like Bearer ***************************

Query Parameters

page

integer

default:1

The page number to retrieve

per

integer

default:10

The number of resources to return per page. There is a limit of 50 results per page.

status

enum<string>

Indicates if the Promo Code is live, disabled, or archived.

Available options:

active,

inactive,

archived

expand

enum<string>[]

Whether or not to expand the Plans on the returned Promo Code(s). Pass an array with each object(s) you want to expand, e.g. [plans]

Available options:

plans,

promo_code

Response

200 - application/json

List Promo Codes

pagination

object

Pagination model

data

object[]

PromoCode model

data.id

string

The ID of the Promo Code, which will look like promo_*************

data.plans

string

The Plans this Promo Code is valid for. By default this will just be the IDs of the Plans, but you can expand it to get more information about the Plan by passing [plan] in the expand parameter.

data.amount_off

number

The amount off (percentage or flat amount) for the Promo Code.

data.base_currency

enum<string>

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

data.code

string

The specific code used to apply the Promo Code at checkout.

data.new_users_only

boolean

Restricts Promo Code use to users who haven't purchased from the company before.

data.number_of_intervals

integer

The number of billing cycles the Promo Code is applied for. By default, it is applied forever (0).

data.plan_ids

array

Please use plans instead, as this field is deprecated.

Whether the Promo Code is a percentage or flat amount off.

Available options:

percentage,

flat_amount

data.status

enum<string>

Indicates if the Promo Code is live, disabled, or archived.

Available options:

active,

inactive,

archived

data.stock

integer

The number of total uses remaining for the Promo Code.

data.unlimited_stock

boolean

Whether or not the Promo Code has unlimited uses.

data.uses

integer

The amount of times the Promo Code has been used.

data.created_at

integer

The time at which the Promo Code was created. Measured in seconds since the Unix epoch.

data.expiration_datetime

integer

The date/time of when the Promo Code expires.

data.metadata

object

A polymorphic object containing information that can be user defined

data.duration

enum<string>

The duration setting for the promo code.

Available options:

forever,

once,

repeating

data.existing_memberships_only

boolean

If true, the promo code can only be applied to existing memberships (post checkout).

Was this page helpful?

List Payment Fees Retrieve a promo code

curl --request GET \
  --url https://api.whop.com/api/v2/promo_codes

{
  "pagination": {
    "current_page": 123,
    "total_page": 123,
    "total_count": 123
  },
  "data": [
    {
      "id": "<string>",
      "plans": "<string>",
      "amount_off": 123,
      "base_currency": "usd",
      "code": "<string>",
      "new_users_only": true,
      "number_of_intervals": 123,
      "plan_ids": [
        [
          "<any>"
        ]
      ],
      "promo_type": "percentage",
      "status": "active",
      "stock": 123,
      "unlimited_stock": true,
      "uses": 123,
      "created_at": 123,
      "expiration_datetime": 123,
      "metadata": {},
      "duration": "forever",
      "existing_memberships_only": true
    }
  ]
}

API Documentation

Memberships

Products

Plans

Experiences

Checkout Sessions

Companies

Members

Payments

Payment Fees

Promo Codes

Reviews

Webhooks

Headers

Query Parameters

Response