GET
https://api.whop.com/api
/
v2
/
promo_codes
/
{id}
curl --request GET \
  --url https://api.whop.com/api/v2/promo_codes/{id}
{
  "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 ***************************

Path Parameters

​
id
string
required

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

Query Parameters

​
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

Retrieve a promo code

PromoCode model