Update a Plan
curl --request POST \
--url https://api.whop.com/api/v2/plans/{id} \
--header 'Authorization: <authorization>' \
--header 'Content-Type: application/json' \
--data '{
"allow_multiple_quantity": true,
"card_payments": true,
"coinbase_commerce_accepted": true,
"expiration_days": 123,
"grace_period_days": 123,
"initial_price": 123,
"internal_notes": "<string>",
"metadata": {},
"one_per_user": true,
"paypal_accepted": true,
"pegged_currencies": [
"<string>"
],
"refillable": true,
"short_link": "<string>",
"stock": 123,
"trial_period_days": 123,
"unlimited_stock": true,
"visibility": "visible"
}'
{
"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"
}
}
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 ***************************
Path Parameters
The ID of the Plan, which will look like plan_*************
Body
Marks whether customers can purchase multiple quantity of the Plan.
Deprecated. Please use accepted_payment_methods
instead.
Whether or not Coinbase Commerce payments are accepted.
The interval at which the Plan charges (expiration plans).
The time period (in days) after a Membership expires where the customer can still top-up.
The price to be initially charged when a user first purchases the Plan
A nickname for the Plan set by the company and not visible to the customer
A key value pair of metadata. Whatever you put on here will be assigned to any memberships that are created on this plan
Marks whether or not a Plan can be purchased multiple times by a user. Used most likely for free trial plans. Default is false
Marks whether paypal payments are/aren't accepted.
An array of currencies that will be pegged to the base currency
Marks whether an expiration Plan can/can't be topped-up.
The short link identifier for the Plan.
The amount of stock left in the Plan
The number of free trial days added before a renewal Plan.
Whether or not the Plan offers unlimited stock
The level of visibility of the Plan
visible
, hidden
, archived
, quick_link
Response
Plan model
Was this page helpful?
curl --request POST \
--url https://api.whop.com/api/v2/plans/{id} \
--header 'Authorization: <authorization>' \
--header 'Content-Type: application/json' \
--data '{
"allow_multiple_quantity": true,
"card_payments": true,
"coinbase_commerce_accepted": true,
"expiration_days": 123,
"grace_period_days": 123,
"initial_price": 123,
"internal_notes": "<string>",
"metadata": {},
"one_per_user": true,
"paypal_accepted": true,
"pegged_currencies": [
"<string>"
],
"refillable": true,
"short_link": "<string>",
"stock": 123,
"trial_period_days": 123,
"unlimited_stock": true,
"visibility": "visible"
}'
{
"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"
}
}