v1
latestOpenAPI 3.0.12026-08-062532117.6 KBGet promotional codes
Returns promotional codes for your program. A promotional code is the string a customer types at checkout; it inherits its discount from the coupon it belongs to, and can be assigned to an affiliate so redemptions are credited to them.
id, code and externalId return a single code. couponId, affiliateId and affiliateEmail return every matching code, newest first. With no parameters, every code in the program is returned.
Each code comes back with its parent coupon and the affiliate it is assigned to.
Query parameters
The promotional code's UUID. Returns a single code.
The code string itself, for example JANE20. Returns a single code.
The code's ID in the connected billing provider, for example a Stripe promotion code ID. Returns a single code.
Return every code belonging to this coupon.
Return every code assigned to this affiliate UUID.
Return every code assigned to the affiliate with this email address.
Response
A single promotional code when filtering by id, code or externalId (null if no match), otherwise an array.