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 ***************************
Path Parameters
The ID of a plan you want to copy the data from, which will look like plan_*************
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]
Body
Create a quick link for a plan
A nickname for the Plan set by the company and not visible to the customer
The description of the Plan as seen by the customer on the checkout page
The short link identifier for the Plan.
The password that must be entered to use this plan. It will automatically be appended to the direct_link
The amount of stock left in the Plan
The number of free trial days added before a renewal Plan.
A key value pair of metadata. Whatever you put on here will be assigned to any memberships that are created on this plan
A key value pair of requirements. By default, requirements will pull from the mimic_plan. Whichever ones are here will overwrite those
Response
Create a quick link for a plan
Plan model
The ID of the Plan, which will look like plan_*************
The ID of the Company this Plan is for, which will look like biz_*************
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
The description of the Plan as seen by the customer on the checkout page
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 currently accepted for this Plan. These are the high-level payment processors that are eligible to be used. This list is dynamically generated based on the plan amount, plan currency, the status of the account's connected payout accounts, and any processor specific enable/disable toggles. The acceptable values are: stripe, coinbase, free, paypal, sezzle, splitit, platform_balance, multi_psp
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.
Whether or not card payments are allowed for this plan.
An array of Custom Field objects that collect additional information from customers during checkout, commonly used with checkout questions.
A short description of the Plan
Marks whether customers can purchase multiple quantity of the Plan.
Whether or not Coinbase Commerce payments are accepted. If disabled, it will never show. If enabled, it will be shown if the purchase meets the correct configuration requirements.
Whether or not Splitit payments are allowed. If disabled, it will never show. If enabled, it will be shown if the purchase meets the correct configuration requirements.
Whether or not Platform Balance payments are allowed. If disabled, it will never show. If enabled, it will be shown if the purchase meets the correct configuration requirements.
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.
Marks whether or not a Plan can be purchased multiple times by a user. Used most likely for free trial plans. Default is false
Marks whether an expiration Plan can/can't be topped-up.
The short link identifier for the Plan.
The number of free trial days added before a renewal Plan.
Marks whether paypal payments are/aren't accepted.
The number of payments required before pausing the subscription.
Whether or not ACH payments are accepted
Whether or not to cancel dependant collab passes if a user loses access to this one. Default is true
Number of billing periods to offer the cancel discount for
Cancel discount percentage
Whether or not to offer a discount on cancellation
Marks whether or not a Plan can be purchased multiple times by a company. Used most likely for free trial plans. Default is false
Overrides the default tax behavior