Skip to main content
GET

Authorizations

x-publisher-token
string
header
required

Publisher token, as displayed in the Publisher Dashboard.

Path Parameters

couponName
string
required

Coupon name.

Example:

"summer26"

promoCodeName
string
required

Promo code name.

Example:

"swx1"

Response

Promo code retrieved successfully.

name
string

Promo code name.

Example:

"swx1"

active
boolean

Whether the promo code is active.

Example:

true

maxRedemptions
integer

Maximum number of times this promo code can be redeemed.

Example:

50

createdAt
string<date-time>

Timestamp when the promo code was created.

Example:

"2025-01-22T15:58:24.116Z"

updatedAt
string<date-time>

Timestamp when the promo code was last updated.

Example:

"2025-01-25T08:44:26.668Z"

redemptions
integer

Number of times this promo code has been redeemed.

Example:

10