Skip to main content
GET
cURL
Retrieve a promo code by its public ID.

Authorizations

x-api-key
string
header
required

Headers

Commet-Version
string
default:2026-08-27

API version used by this reference. Send this header to select this contract explicitly.

Path Parameters

id
string
required

Response

Success

id
string
required
code
string
required
offerId
string
required
billingInterval
enum<string> | null
required
Available options:
weekly,
monthly,
quarterly,
semiannual,
yearly,
one_time
maxRedemptions
integer | null
required
Required range: -9007199254740991 <= x <= 9007199254740991
expiresAt
string<date-time> | null
required
isActive
boolean
required
redemptionCount
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
firstPurchaseOnly
boolean
required

Whether the code only applies to a customer's first purchase: one with no paid invoice above zero and no paid subscription.

managedBy
enum<string> | null
required

Integration that manages this record, or null when the merchant does. While an integration manages it, its terms change only in that integration and edits answer 409 managed_by_integration.

Available options:
dub
createdAt
string<date-time>
required
updatedAt
string<date-time>
required
object
string
required
Allowed value: "promo_code"
livemode
boolean
required