POST
/
v2
/
oauth
/
company
/
plans
/
{id}

Headers

Authorization
string
required

A user's access token, which must be retrieved from the Whop OAuth2 authentication flow. You must prepend your key with the word 'Bearer', which will look like Bearer ***************************

Path Parameters

id
string
required

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

Body

application/json

Update a plan using an experience access token

stock
integer

The amount of stock left in the Plan

unlimited_stock
boolean

Whether or not the Plan offers unlimited stock

visibility
enum<string>

The level of visibility of the Plan

Available options:
visible,
hidden,
archived,
quick_link
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

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

refillable
boolean

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

short_link
string

The short link identifier for the Plan.

trial_period_days
integer

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

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

paypal_accepted
boolean

Marks whether paypal payments are/aren't accepted.

Response

201 - application/json
data
object

Plan model

Was this page helpful?