GET
/
v2
/
promo_codes

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 ***************************

Query Parameters

page
integer
default: 1

The page number to retrieve

per
integer
default: 10

The number of resources to return per page. There is a limit of 50 results per page.

status
enum<string>

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

Available options:
active,
inactive,
archived
expand
enum<string>[]

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]

Available options:
plans,
promo_code

Response

200 - application/json
pagination
object

Pagination model

data
object[]

Was this page helpful?

Retrieve a PaymentRetrieve a promo code