API Reference

Create a plan

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

Create a plan

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
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

Create a plan

string

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

string

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

string
enum
Defaults to one_time

Whether the Plan is a renewal or one-time purchase

Allowed:
boolean

Marks whether customers can purchase multiple quantity of the Plan.

string
enum
Defaults to usd

The base currency

int32

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

boolean

Deprecated. Please use accepted_payment_methods instead.

boolean

Whether or not Coinbase Commerce payments are accepted.

custom_fields
array of strings

An array of custom field objects.

custom_fields
int32

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

int32

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

float

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

string

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

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
boolean

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

string
enum

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

Allowed:
release_method_settings
object

Configurable settings on how this Plan is released.

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

string

The short link identifier for the Plan.

int32

The amount of stock left in the Plan

int32

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

boolean

Whether or not the Plan offers unlimited stock

string
enum

The level of visibility of the Plan

Allowed:
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
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

Updated over 2 years ago

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated over 2 years ago