Update a promo code

post

https://api.whop.com/api/v2/promo_codes/{id}

Update a promo code's applicable plans

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

string

required

The ID of the Promo Code, which will look like promo_*************

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

Update a promo code

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.

status

string

enum

Indicates if the Promo Code is live, disabled, or archived.

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

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

201Update a promo code