Update a promo code

Update a promo code's applicable plans

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
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
int32

The number of total uses remaining for the Promo Code.

boolean

Whether or not the Promo Code has unlimited uses.

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
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
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json