List Plans

GET

plans

curl --request GET \
  --url https://api.whop.com/api/v2/plans

{
  "pagination": {
    "current_page": 123,
    "total_page": 123,
    "total_count": 123
  },
  "data": [
    {
      "id": "<string>",
      "product": "<string>",
      "plan_type": "<string>",
      "release_method": "<string>",
      "visibility": "visible",
      "billing_period": 123,
      "internal_notes": "<string>",
      "payment_link_description": "<string>",
      "metadata": {},
      "direct_link": "<string>",
      "renewal_price": 123,
      "initial_price": 123,
      "base_currency": "<string>",
      "requirements": {},
      "release_method_settings": {},
      "accepted_payment_methods": [
        [
          "<any>"
        ]
      ],
      "stock": 123,
      "unlimited_stock": true,
      "created_at": 123,
      "access_pass": "<string>",
      "card_payments": 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 ***************************

Query Parameters

page

integer

default:1

The page number to retrieve

per

integer

default:10

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

visibility

enum<string>

The level of visibility of the Plan

Available options:

visible,

hidden,

archived,

quick_link

access_pass_id

string

Access Pass has been deprecated for Product. Please use product instead and do not use access_pass.

product_id

string

The Plan's Product ID, which will look like prod_************* or pass_*************

expand

enum<string>[]

Whether or not to expand the Product on the returned Plan(s). Pass an array with each object(s) you want to expand, e.g. [product]

Available options:

product

Response

200 - application/json

List Plans

pagination

object

Pagination model

data

object[]

Plan model

data.id

string

The ID of the Plan, which will look like plan_*************

data.product

string

The Product this Plan is tied to. By default this will just be the ID of the Product, but you can expand it to get more information about the Product by passing [product] in the expand parameter.

data.plan_type

string

Whether the Plan is a renewal or one-time purchase

data.release_method

string

The method the customer will use to gain access to this Plan's Product

data.visibility

enum<string>

The level of visibility of the Plan

Available options:

visible,

hidden,

archived,

quick_link

data.billing_period

integer

How often a user will get charged for their membership (if it is a renewal plan), in number of days

data.internal_notes

string

A nickname for the Plan set by the company and not visible to the customer

data.payment_link_description

string

The description of the Plan as seen by the customer on the checkout page

data.metadata

object

A polymorphic object containing information that can be user defined

data.direct_link

string

A URL that targets a customer on this specific Plan

data.renewal_price

number

The price to be charged for each successive billing period

data.initial_price

number

The price to be initially charged when a user first purchases the Plan

data.base_currency

string

The base currency

data.requirements

object

Represents the different restrictions (if any) in place for purchasing the Plan

data.release_method_settings

object

Configurable settings on how this Plan is released.

data.accepted_payment_methods

array

An array of payment methods that are accepted for this Plan

data.stock

integer

The amount of stock left in the Plan

data.unlimited_stock

boolean

Whether or not the Plan offers unlimited stock

data.created_at

integer

The time at which the Plan was created. Measured in seconds since the Unix epoch.

data.access_pass

string

Access Pass has been deprecated for Product. Please use product instead and do not use access_pass.

data.card_payments

boolean

Deprecated. Please use accepted_payment_methods instead.

Was this page helpful?

Update a Product Retrieve a Plan

curl --request GET \
  --url https://api.whop.com/api/v2/plans

{
  "pagination": {
    "current_page": 123,
    "total_page": 123,
    "total_count": 123
  },
  "data": [
    {
      "id": "<string>",
      "product": "<string>",
      "plan_type": "<string>",
      "release_method": "<string>",
      "visibility": "visible",
      "billing_period": 123,
      "internal_notes": "<string>",
      "payment_link_description": "<string>",
      "metadata": {},
      "direct_link": "<string>",
      "renewal_price": 123,
      "initial_price": 123,
      "base_currency": "<string>",
      "requirements": {},
      "release_method_settings": {},
      "accepted_payment_methods": [
        [
          "<any>"
        ]
      ],
      "stock": 123,
      "unlimited_stock": true,
      "created_at": 123,
      "access_pass": "<string>",
      "card_payments": true
    }
  ]
}

API Documentation

Memberships

Products

Plans

Experiences

Checkout Sessions

Companies

Members

Payments

Payment Fees

Promo Codes

Reviews

Webhooks

Headers

Query Parameters

Response