POST

/v2/plans/{id}

Authorization*
curl --request POST \
  --url https://api.whop.com/v2/plans/{id} \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json'
{
  "data": {
    "accepted_payment_methods": [
      "array"
    ],
    "access_pass": "string",
    "base_currency": "string",
    "billing_period": "integer",
    "card_payments": "boolean",
    "created_at": "integer",
    "direct_link": "string",
    "id": "string",
    "initial_price": "number",
    "internal_notes": "string",
    "metadata": "object",
    "plan_type": "string",
    "product": "string",
    "release_method": "string",
    "release_method_settings": "object",
    "renewal_price": "number",
    "requirements": "object",
    "stock": "integer",
    "unlimited_stock": "boolean",
    "visibility": "visible"
  }
}
Authorizationrequired
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

idrequired
string

The ID of the Plan, which will look like plan_*************

​
Body

allow_multiple_quantity
boolean

Marks whether customers can purchase multiple quantity of the Plan.

card_payments
boolean

Deprecated. Please use accepted_payment_methods instead.

coinbase_commerce_accepted
boolean

Whether or not Coinbase Commerce payments are accepted.

expiration_days
integer

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

grace_period_days
integer

The time period (in days) after a Membership expires where the customer can still top-up.

initial_price
number

The price to be initially charged when a user first purchases the Plan

internal_notes
string

A nickname for the Plan set by the company and not visible to the customer

metadata
object

A key value pair of metadata. Whatever you put on here will be assigned to any memberships that are created on this plan

one_per_user
boolean

Marks whether or not a Plan can be purchased multiple times by a user. Used most likely for free trial plans. Default is false

paypal_accepted
boolean

Marks whether paypal payments are/aren't accepted.

pegged_currencies
string[]

An array of currencies that will be pegged to the base currency

refillable
boolean

Marks whether an expiration Plan can/can't be topped-up.

short_link
string

The short link identifier for the Plan.

stock
integer

The amount of stock left in the Plan

trial_period_days
integer

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

unlimited_stock
boolean

Whether or not the Plan offers unlimited stock

visibility
string

The level of visibility of the Plan

Available options:
visible,
hidden,
archived,
quick_link

​
Response

data
object

Plan model

Retrieve a PlanCreate a plan