Skip to main content
GET
/
plans
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 planListResponse of client.plans.list({ company_id: 'biz_xxxxxxxxxxxxxx' })) {
  console.log(planListResponse.id);
}
{
  "data": [
    {
      "id": "plan_xxxxxxxxxxxxx",
      "created_at": "2023-12-01T05:00:00.401Z",
      "updated_at": "2023-12-01T05:00:00.401Z",
      "visibility": "visible",
      "plan_type": "renewal",
      "release_method": "buy_now",
      "currency": "usd",
      "company": {
        "id": "biz_xxxxxxxxxxxxxx",
        "title": "Pickaxe"
      },
      "product": {
        "id": "prod_xxxxxxxxxxxxx",
        "title": "Pickaxe Analytics"
      },
      "invoice": {
        "id": "inv_xxxxxxxxxxxxxx"
      },
      "billing_period": 42,
      "title": "Pro Monthly",
      "description": "Monthly access to all premium analytics dashboards and data exports.",
      "purchase_url": "https://whop.com/pickaxe-analytics/checkout/plan_abc123",
      "expiration_days": 42,
      "initial_price": 6.9,
      "renewal_price": 6.9,
      "trial_period_days": 42,
      "member_count": 42,
      "internal_notes": "Black Friday 2024 promo plan - expires Dec 1",
      "stock": 42,
      "unlimited_stock": true,
      "split_pay_required_payments": 42,
      "payment_method_configuration": {
        "enabled": [
          "acss_debit"
        ],
        "disabled": [
          "acss_debit"
        ],
        "include_platform_defaults": true
      }
    }
  ],
  "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 plans for.

Example:

"biz_xxxxxxxxxxxxxx"

​
direction
enum<string> | null

The sort direction for results. Defaults to descending.

Available options:
asc,
desc
​
order
enum<string> | null

The field to sort results by. Defaults to created_at.

Available options:
id,
active_members_count,
created_at,
internal_notes,
expires_at
​
release_methods
enum<string>[] | null

Filter to only plans matching these release methods.

The methods of how a plan can be released.

Available options:
buy_now,
waitlist
​
visibilities
enum<string>[] | null

Filter to only plans matching these visibility states.

The different levels of visibility for resources

Available options:
visible,
hidden,
archived,
quick_link,
all,
not_quick_link,
not_archived
​
plan_types
enum<string>[] | null

Filter to only plans matching these billing types.

The type of plan that can be attached to a product

Available options:
renewal,
one_time
​
product_ids
string[] | null

Filter to only plans belonging 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.

​
created_before
string<date-time> | null

Only return plans created before this timestamp.

Example:

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

​
created_after
string<date-time> | null

Only return plans created after this timestamp.

Example:

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

Response

A successful response

The connection type for PublicPlan.

​
data
object[]
required

A list of nodes.

​
page_info
object
required

Information to aid in pagination.