Skip to main content
GET
Error

Authorizations

Authorization
string
header
required

JWT Authorization header using the Bearer scheme.

Path Parameters

couponSetCode
string
required
couponCode
string
required

Query Parameters

includeCounts
boolean
default:false
responseGroups
string
responseFields
string

limits which fields are returned in the response body

Response

OK

Coupon in a coupon set.

couponCode
string
required

The code the customer uses to claim this coupon

Minimum string length: 1
auditInfo
object
canBeDeleted
boolean
couponSetCode
string | null

Link to associated coupon

couponSetId
integer<int32>

ReadOnly system id for releated couponset.

redemptionCount
integer<int32> | null

Total number of times this code has been redeemed. ReadOnly, calculated. Only returned with response group includeCounts