Create a promotion code

Required scope: promotion-codes:write
Organization authorization: supported

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required
length ≥ 1

Name of the promotion code

string
required
^[a-z0-9]+(?:-[a-z0-9]+)*$

Unique code string. Must be lowercase alphanumeric, optionally hyphen-separated (e.g. summer-2025).

string | null

Description of the promotion code

double
required
0.1 to 500

Percentage for discount types (max 100), or currency amount for the credit type (max 500).

int32 | null
≥ 1

Maximum number of times the code can be used

date-time | null

When the promotion code becomes active (ISO8601: yyyy-MM-ddTHH:mm:ssZ)

date-time | null

When the promotion code expires (ISO8601: yyyy-MM-ddTHH:mm:ssZ)

string | null

Type of the promotion code

int64 | null

User ID to limit this code to a specific user

number | null
0.01 to 999999.99

Cap on total discount applied across all uses. Once reached, the code becomes unusable. Omit to set no cap.

selectedTeamIds
array of int64s | null

Team IDs the promotion code is restricted to. Omit or pass an empty array to leave the code unrestricted.

selectedTeamIds
int32 | null
1 to 10000

Max charges per driver eligible for the discount after redeeming. Omit to set no limit.

Responses

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json