Create a plan

post https://api.whop.com/api/v2/plans

Create a plan

Query Params

expand

array of strings

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]

expand

Body Params

product_id

string

The Plan's Product ID, which will look like prod_************* or pass_*************

access_pass_id

string

Access Pass has been deprecated for Product. Please use product instead and do not use access_pass.

plan_type

string

Defaults to one_time

Whether the Plan is a renewal or one-time purchase

allow_multiple_quantity

boolean

Marks whether customers can purchase multiple quantity of the Plan.

base_currency

string

Defaults to usd

The base currency

billing_period

int32

How often a user will get charged for their membership (if it is a renewal plan), in number of days

card_payments

boolean

Deprecated. Please use accepted_payment_methods instead.

coinbase_commerce_accepted

boolean

Whether or not Coinbase Commerce payments are accepted.

custom_fields

array of strings

An array of custom field objects.

custom_fields

expiration_days

int32

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

grace_period_days

int32

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

initial_price

float

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

pegged_currencies

array of strings

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

pegged_currencies

refillable

boolean

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

release_method

string

The method the customer will use to gain access to this Plan's Product

release_method_settings

object

Configurable settings on how this Plan is released.

renewal_price

float

The price to be charged for each successive billing period

requirements

object

Represents the different restrictions (if any) in place for purchasing the Plan

short_link

string

The short link identifier for the Plan.

stock

int32

The amount of stock left in the Plan

trial_period_days

int32

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

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

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 ***************************

Response

Language


xxxxxxxxxx
10
1
curl --request POST \
2
     --url https://api.whop.com/api/v2/plans \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "plan_type": "one_time",
8
  "base_currency": "usd"
9
}
10
'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201Create a plan