Skip to main content
GET
/
plans
/
{id}
JavaScript
import Whop from '@whop/sdk';

const client = new Whop({
  appID: 'app_xxxxxxxxxxxxxx',
  apiKey: 'My API Key',
});

const plan = await client.plans.retrieve('plan_xxxxxxxxxxxxx');

console.log(plan.id);
{
  "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_url": "<string>",
  "expiration_days": 42,
  "initial_price": 6.9,
  "renewal_price": 6.9,
  "trial_period_days": 42,
  "member_count": 42,
  "internal_notes": "<string>",
  "tax_type": "inclusive",
  "collect_tax": true,
  "custom_fields": [
    {
      "id": "field_xxxxxxxxxxxx",
      "field_type": "<string>",
      "name": "<string>",
      "order": 42,
      "placeholder": "<string>",
      "required": true
    }
  ]
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
id
string
required
Example:

"plan_xxxxxxxxxxxxx"

Response

A successful response

An object representing a (sanitized) plan of an access pass.

​
id
string
required

The internal ID of the plan.

Example:

"plan_xxxxxxxxxxxxx"

​
created_at
integer
required

When the plan was created.

Example:

1701406800

​
updated_at
integer
required

When the plan was last updated.

Example:

1701406800

​
visibility
enum<string>
required

Shows or hides the plan from public/business view.

Available options:
visible,
hidden,
archived,
quick_link
​
plan_type
enum<string>
required

Indicates if the plan is a one time payment or recurring.

Available options:
renewal,
one_time
​
release_method
enum<string>
required

This is the release method the business uses to sell this plan.

Available options:
buy_now,
waitlist
​
currency
enum<string>
required

The respective currency identifier for the plan.

Available options:
usd,
sgd,
inr,
aud,
brl,
cad,
dkk,
eur,
nok,
gbp,
sek,
chf,
hkd,
huf,
jpy,
mxn,
myr,
pln,
czk,
nzd,
aed,
eth,
ape,
cop,
ron,
thb,
bgn,
idr,
dop,
php,
try,
krw,
twd,
vnd,
pkr,
clp,
uyu,
ars,
zar,
dzd,
tnd,
mad,
kes,
kwd,
jod,
all,
xcd,
amd,
bsd,
bhd,
bob,
bam,
khr,
crc,
xof,
egp,
etb,
gmd,
ghs,
gtq,
gyd,
ils,
jmd,
mop,
mga,
mur,
mdl,
mnt,
nad,
ngn,
mkd,
omr,
pyg,
pen,
qar,
rwf,
sar,
rsd,
lkr,
tzs,
ttd,
uzs,
rub,
btc
​
company
object | null
required

The company for the plan.

​
product
object | null
required

The access pass for the plan.

​
invoice
object | null
required

The invoice associated with this plan.

​
billing_period
integer | null
required

The interval at which the plan charges (renewal plans).

Example:

42

​
description
string | null
required

The description of the plan.

​
purchase_url
string
required

The direct link to purchase the product.

​
expiration_days
integer | null
required

The interval at which the plan charges (expiration plans).

Example:

42

​
initial_price
number
required

The price a person has to pay for a plan on the initial purchase.

Example:

6.9

​
renewal_price
number
required

The price a person has to pay for a plan on the renewal purchase.

Example:

6.9

​
trial_period_days
integer | null
required

The number of free trial days added before a renewal plan.

Example:

42

​
member_count
integer | null
required

The number of members for the plan.

Example:

42

​
internal_notes
string | null
required

A personal description or notes section for the business.

​
tax_type
enum<string>
required

The tax type for the plan.

Available options:
inclusive,
exclusive,
unspecified
​
collect_tax
boolean
required

Whether or not the plan collects tax.

​
custom_fields
object[]
required

The custom fields for the plan.

⌘I