GET
/
v2
/
plans
/
{id}
curl --request GET \
  --url https://api.whop.com/api/v2/plans/{id}
{
  "id": "<string>",
  "product": "<string>",
  "plan_type": "<string>",
  "release_method": "<string>",
  "visibility": "visible",
  "billing_period": 123,
  "internal_notes": "<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 ***************************

Path Parameters

id
string
required

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

Query Parameters

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
id
string

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

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.

plan_type
string

Whether the Plan is a renewal or one-time purchase

release_method
string

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

visibility
enum<string>

The level of visibility of the Plan

Available options:
visible,
hidden,
archived,
quick_link
billing_period
integer

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

internal_notes
string

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

metadata
object

A polymorphic object containing information that can be user defined

direct_link
string

A URL that targets a customer on this specific Plan

renewal_price
number

The price to be charged for each successive billing period

initial_price
number

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

base_currency
string

The base currency

requirements
object

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

release_method_settings
object

Configurable settings on how this Plan is released.

accepted_payment_methods
array

An array of payment methods that are accepted for this Plan

stock
integer

The amount of stock left in the Plan

unlimited_stock
boolean

Whether or not the Plan offers unlimited stock

created_at
integer

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

access_pass
string

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

card_payments
boolean

Deprecated. Please use accepted_payment_methods instead.

Was this page helpful?

List PlansUpdate a Plan