Skip to main content
GET
/
plans
List Plan
curl --request GET \
  --url https://api.whop.com/api/v1/plans \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "plan_xxxxxxxxxxxxx",
      "created_at": 1701406800,
      "updated_at": 1701406800,
      "visibility": "visible",
      "plan_type": "renewal",
      "release_method": "buy_now",
      "currency": "usd",
      "company": {
        "id": "biz_xxxxxxxxxxxxxx",
        "title": "<string>"
      },
      "product": {
        "id": "prod_xxxxxxxxxxxxx",
        "title": "<string>"
      },
      "invoice": {
        "id": "inv_xxxxxxxxxxxxxx"
      },
      "billing_period": 42,
      "description": "<string>",
      "purchase_link": "<string>",
      "expiration_days": 42,
      "initial_price": 6.9,
      "renewal_price": 6.9,
      "trial_period_days": 42,
      "member_count": 42,
      "internal_notes": "<string>"
    }
  ],
  "page_info": {
    "end_cursor": "<string>",
    "start_cursor": "<string>",
    "has_next_page": true,
    "has_previous_page": true
  }
}

Authorizations

​
Authorization
string
header
required

The app API key from an app from the /dashboard/developer page

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 ID of the company

Example:

"biz_xxxxxxxxxxxxxx"

​
direction
enum<string> | null

The direction to sort the plans by The direction of the sort.

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

The order to sort the plans by The ways a relation of Plans can be ordered

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

The release method to filter the plans by

​
visibilities
(enum<string> | null)[] | null

The visibility to filter the plans by

​
plan_types
(enum<string> | null)[] | null

The plan type to filter the plans by

​
product_ids
string[] | null

The access pass IDs to filter the plans by

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.

Response

A successful response

The connection type for PublicPlan.

​
data
array | null
required

A list of nodes.

​
page_info
object | null
required

Information to aid in pagination. Information about pagination in a connection.