Plans
List Plans
Returns a collection of Plans, based on the supplied filters. Plans represent a pricing and release method configuration used to purchase a Product.
GET
/
v2
/
plans
Header
Query
curl --request GET \
--url https://api.whop.com/api/v2/plans
{
"data": [
{
"accepted_payment_methods": [],
"access_pass": "<string>",
"base_currency": "<string>",
"billing_period": 123,
"card_payments": true,
"created_at": 123,
"direct_link": "<string>",
"id": "<string>",
"initial_price": 123,
"internal_notes": "<string>",
"metadata": {},
"plan_type": "<string>",
"product": "<string>",
"release_method": "<string>",
"release_method_settings": {},
"renewal_price": 123,
"requirements": {},
"stock": 123,
"unlimited_stock": true,
"visibility": "visible"
}
],
"pagination": {
"current_page": 123,
"total_count": 123,
"total_page": 123
}
}
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: 1The page number to retrieve
per
integer
default: 10The 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
data
object[]
pagination
object
Pagination model
Was this page helpful?
curl --request GET \
--url https://api.whop.com/api/v2/plans
{
"data": [
{
"accepted_payment_methods": [],
"access_pass": "<string>",
"base_currency": "<string>",
"billing_period": 123,
"card_payments": true,
"created_at": 123,
"direct_link": "<string>",
"id": "<string>",
"initial_price": 123,
"internal_notes": "<string>",
"metadata": {},
"plan_type": "<string>",
"product": "<string>",
"release_method": "<string>",
"release_method_settings": {},
"renewal_price": 123,
"requirements": {},
"stock": 123,
"unlimited_stock": true,
"visibility": "visible"
}
],
"pagination": {
"current_page": 123,
"total_count": 123,
"total_page": 123
}
}