Create a plan
Create a plan
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 ***************************
Query Parameters
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]
product Body
The Plan's Product ID, which will look like prod_************* or pass_*************
Access Pass has been deprecated for Product. Please use product instead and do not use access_pass.
Whether the Plan is a renewal or one-time purchase
renewal, one_time Marks whether customers can purchase multiple quantity of the Plan.
The base currency
usd, sgd, inr, aud, brl, cad, dkk, eur, nok, gbp, sek, chf, hkd, huf, jpy, mxn, myr, pln, czk, nzd, aed, eth, ape, cop, ron, thb How often a user will get charged for their membership (if it is a renewal plan), in number of days
Deprecated. Please use accepted_payment_methods instead.
Whether or not Coinbase Commerce payments are accepted.
An array of custom field objects.
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
Marks whether or not a Plan can be purchased multiple times by a user. Used most likely for free trial plans. Default is false
An array of currencies that will be pegged to the base currency
Marks whether an expiration Plan can/can't be topped-up.
The method the customer will use to gain access to this Plan's Product
buy_now, waitlist, raffle Configurable settings on how this Plan is released.
The price to be charged for each successive billing period
Represents the different restrictions (if any) in place for purchasing the Plan
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 A key value pair of metadata. Whatever you put on here will be assigned to any memberships that are created on this plan
Response
The ID of the Plan, which will look like plan_*************
The Product this Plan is tied to. By default this will just be the ID of the Product, but you can expand it to get more information about the Product by passing [product] in the expand parameter.
Whether the Plan is a renewal or one-time purchase
The method the customer will use to gain access to this Plan's Product
The level of visibility of the Plan
visible, hidden, archived, quick_link How often a user will get charged for their membership (if it is a renewal plan), in number of days
A nickname for the Plan set by the company and not visible to the customer
A polymorphic object containing information that can be user defined
A URL that targets a customer on this specific Plan
The price to be charged for each successive billing period
The price to be initially charged when a user first purchases the Plan
The base currency
Represents the different restrictions (if any) in place for purchasing the Plan
Configurable settings on how this Plan is released.
An array of payment methods that are accepted for this Plan
The amount of stock left in the Plan
Whether or not the Plan offers unlimited stock
The time at which the Plan was created. Measured in seconds since the Unix epoch.
Access Pass has been deprecated for Product. Please use product instead and do not use access_pass.
Deprecated. Please use accepted_payment_methods instead.
Was this page helpful?