GET
https://api.whop.com/api
/
v2
/
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]

Response

200 - application/json

List Promo Codes

The response is of type object.