Create a quick link

post https://api.whop.com/api/v2/plans/{mimic_plan_id}/create_quick_link

Create a quick link (or release link) for a plan. This will copy over all data from an existing plan and make a new plan with the same data that can be used as a one-time release link. You can change the stock and metadata on the new plan.

Path Params

mimic_plan_id

string

required

The ID of a plan you want to copy the data from, which will look like 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

internal_notes

string

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

short_link

string

The short link identifier for the Plan.

custom_password

string

The password that must be entered to use this plan. It will automatically be appended to the direct_link

stock

int32

Defaults to 1

The amount of stock left in the Plan

trial_period_days

int32

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

requirements

object

A key value pair of requirements. By default, requirements will pull from the mimic_plan. Whichever ones are here will overwrite those

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
1
curl --request POST \
2
     --url https://api.whop.com/api/v2/plans/mimic_plan_id/create_quick_link \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '{"stock":1}'

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

application/json

201Create a quick link for a plan