Create a promo code

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

Creates a new promo code with the given parameters. A promo code can offer a discount or a free period for a specific set of plans or for all plans in your company.

Query Params

expand

array of strings

Whether or not to expand the Plans on the returned Promo Code(s). Pass an array with each object(s) you want to expand, e.g. [plans]

expand

Body Params

amount_off

float

required

The amount off (percentage or flat amount) for the Promo Code.

base_currency

string

required

The monetary currency of the Promo Code.

code

string

required

The specific code used to apply the Promo Code at checkout.

promo_type

string

required

Whether the Promo Code is a percentage or flat amount off.

expiration_datetime

int32

The date/time of when the Promo Code expires.

new_users_only

boolean

Defaults to false

Restricts Promo Code use to users who haven't purchased from the company before.

number_of_intervals

int32

Defaults to 0

The number of billing cycles the Promo Code is applied for. By default, it is applied forever (0).

plan_ids

array of strings

The IDs of plans associated with the Promo Code. Use JSON as your content-type when setting this. Form encoded data will not work well with arrays.

plan_ids

stock

int32

The number of total uses remaining for the Promo Code.

unlimited_stock

boolean

Whether or not the Promo Code has unlimited uses.

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
12
1
curl --request POST \
2
     --url https://api.whop.com/api/v2/promo_codes \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "base_currency": "usd",
8
  "promo_type": "percentage",
9
  "new_users_only": false,
10
  "number_of_intervals": 0
11
}
12
'

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

application/json

201Creates a promo code