Skip to main content
GET
/
promo_codes
JavaScript
import Whop from '@whop/sdk';

const client = new Whop({
  apiKey: process.env['WHOP_API_KEY'], // This is the default and can be omitted
});

// Automatically fetches more pages as needed.
for await (const promoCodeListResponse of client.promoCodes.list({
  company_id: 'biz_xxxxxxxxxxxxxx',
})) {
  console.log(promoCodeListResponse.id);
}
{
  "data": [
    {
      "id": "promo_xxxxxxxxxxxx",
      "amount_off": 6.9,
      "currency": "usd",
      "churned_users_only": true,
      "code": "<string>",
      "created_at": "2023-12-01T05:00:00.401Z",
      "existing_memberships_only": true,
      "duration": "forever",
      "expires_at": "2023-12-01T05:00:00.401Z",
      "new_users_only": true,
      "promo_duration_months": 42,
      "one_per_customer": true,
      "product": {
        "id": "prod_xxxxxxxxxxxxx",
        "title": "Pickaxe Analytics"
      },
      "promo_type": "percentage",
      "status": "active",
      "stock": 42,
      "unlimited_stock": true,
      "uses": 42
    }
  ],
  "page_info": {
    "end_cursor": "<string>",
    "start_cursor": "<string>",
    "has_next_page": true,
    "has_previous_page": true
  }
}

Authorizations

​
Authorization
string
header
required

A company API key, company scoped JWT, app API key, or user OAuth token. You must prepend your key/token with the word 'Bearer', which will look like Bearer ***************************

Query Parameters

​
after
string | null

Returns the elements in the list that come after the specified cursor.

​
before
string | null

Returns the elements in the list that come before the specified cursor.

​
first
integer | null

Returns the first n elements from the list.

Example:

42

​
last
integer | null

Returns the last n elements from the list.

Example:

42

​
company_id
string
required

The unique identifier of the company to list promo codes for.

Example:

"biz_xxxxxxxxxxxxxx"

​
product_ids
string[] | null

Filter to only promo codes scoped to these product identifiers.

Represents a unique identifier that is Base64 obfuscated. It is often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "VXNlci0xMA==") or integer (such as 4) input value will be accepted as an ID.

​
plan_ids
string[] | null

Filter to only promo codes scoped to these plan identifiers.

Represents a unique identifier that is Base64 obfuscated. It is often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "VXNlci0xMA==") or integer (such as 4) input value will be accepted as an ID.

​
status
enum<string> | null

Filter to only promo codes matching this status.

Available options:
active,
inactive,
archived
​
created_before
string<date-time> | null

Only return promo codes created before this timestamp.

Example:

"2023-12-01T05:00:00.401Z"

​
created_after
string<date-time> | null

Only return promo codes created after this timestamp.

Example:

"2023-12-01T05:00:00.401Z"

Response

A successful response

The connection type for PromoCode.

​
data
object[]
required

A list of nodes.

​
page_info
object
required

Information to aid in pagination.