API Documentation
Memberships
Experiences
Checkout Sessions
Companies
Payment Fees
Promo Codes
Plans
Create a plan
Create a plan
POST
https://api.whop.com/api
/
v2
/
plans
curl --request POST \
--url https://api.whop.com/api/v2/plans \
--header 'Content-Type: application/json' \
--data '{
"product_id": "<string>",
"access_pass_id": "<string>",
"plan_type": "one_time",
"allow_multiple_quantity": true,
"base_currency": "usd",
"billing_period": 123,
"card_payments": true,
"coinbase_commerce_accepted": true,
"expiration_days": 123,
"grace_period_days": 123,
"initial_price": 123,
"internal_notes": "<string>",
"payment_link_description": "<string>",
"one_per_user": true,
"refillable": true,
"release_method": "buy_now",
"release_method_settings": {},
"renewal_price": 123,
"requirements": {},
"short_link": "<string>",
"stock": 123,
"trial_period_days": 123,
"unlimited_stock": true,
"visibility": "visible",
"metadata": {},
"paypal_accepted": true,
"split_pay_required_payments": 123
}'
{
"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
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
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]
Body
application/json
Create a plan
Response
201 - application/json
Create a plan
Plan model
Was this page helpful?
curl --request POST \
--url https://api.whop.com/api/v2/plans \
--header 'Content-Type: application/json' \
--data '{
"product_id": "<string>",
"access_pass_id": "<string>",
"plan_type": "one_time",
"allow_multiple_quantity": true,
"base_currency": "usd",
"billing_period": 123,
"card_payments": true,
"coinbase_commerce_accepted": true,
"expiration_days": 123,
"grace_period_days": 123,
"initial_price": 123,
"internal_notes": "<string>",
"payment_link_description": "<string>",
"one_per_user": true,
"refillable": true,
"release_method": "buy_now",
"release_method_settings": {},
"renewal_price": 123,
"requirements": {},
"short_link": "<string>",
"stock": 123,
"trial_period_days": 123,
"unlimited_stock": true,
"visibility": "visible",
"metadata": {},
"paypal_accepted": true,
"split_pay_required_payments": 123
}'
{
"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
}
Assistant
Responses are generated using AI and may contain mistakes.