Promo Codes
List Promo Codes
List all promo codes.
GET
/
v2
/
promo_codes
Header
Query
curl --request GET \
--url https://api.whop.com/api/v2/promo_codes
{
"data": [
{
"amount_off": 123,
"base_currency": "usd",
"code": "<string>",
"created_at": 123,
"duration": "forever",
"existing_memberships_only": true,
"expiration_datetime": 123,
"id": "<string>",
"metadata": {},
"new_users_only": true,
"number_of_intervals": 123,
"plan_ids": [],
"plans": "<string>",
"promo_type": "percentage",
"status": "active",
"stock": 123,
"unlimited_stock": true,
"uses": 123
}
],
"pagination": {
"current_page": 123,
"total_count": 123,
"total_page": 123
}
}
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: 1The page number to retrieve
per
integer
default: 10The 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
data
object[]
pagination
object
Pagination model
Was this page helpful?
curl --request GET \
--url https://api.whop.com/api/v2/promo_codes
{
"data": [
{
"amount_off": 123,
"base_currency": "usd",
"code": "<string>",
"created_at": 123,
"duration": "forever",
"existing_memberships_only": true,
"expiration_datetime": 123,
"id": "<string>",
"metadata": {},
"new_users_only": true,
"number_of_intervals": 123,
"plan_ids": [],
"plans": "<string>",
"promo_type": "percentage",
"status": "active",
"stock": 123,
"unlimited_stock": true,
"uses": 123
}
],
"pagination": {
"current_page": 123,
"total_count": 123,
"total_page": 123
}
}