GET

/v2/promo_codes

Authorization
curl --request GET \
  --url https://api.whop.com/v2/promo_codes
{
  "data": [
    {
      "amount_off": "number",
      "base_currency": "usd",
      "code": "string",
      "created_at": "integer",
      "duration": "forever",
      "existing_memberships_only": "boolean",
      "expiration_datetime": "integer",
      "id": "string",
      "metadata": "object",
      "new_users_only": "boolean",
      "number_of_intervals": "integer",
      "plan_ids": [
        "array"
      ],
      "plans": "string",
      "promo_type": "percentage",
      "status": "active",
      "stock": "integer",
      "unlimited_stock": "boolean",
      "uses": "integer"
    }
  ],
  "pagination": {
    "current_page": "integer",
    "total_count": "integer",
    "total_page": "integer"
  }
}
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
Default: "1"
integer

The page number to retrieve

per
Default: "10"
integer

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

status
string

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

expand
array

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

data
array
pagination
object

Pagination model

Retrieve a PaymentRetrieve a promo code