GET
/
v2
/
plans
/
{id}
Retrieve a Plan
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>",
  "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 ***************************

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]

Response

200 - application/json

Retrieve a Plan

Plan model