The response is illustrative, not the result of a live request.
Request parameters
Query parameters
This operation takes no request parameters.
Response fields
Successful responses include requestId and scope. Use the actual business status or accepted field to determine the result. Optional fields are omitted when unavailable.
HTTP 200 · application/json
requestIduuidRequired
Server-generated HTTP request UUID. Include it when reporting a failed request.
scopeobjectRequired
The App and environment of this response. Headers only verify scope; they cannot switch key scope.
Show child fields
projectIdstringRequired
App ID bound to the credential.
minLength: 1
environmentenumRequired
Separate data scope: sandbox or live.
Show allowed values
"sandbox""live"
offersarrayRequired
The offers value for this operation. Its accepted type and constraints are listed above and below.
Show child fields
iduuidRequired
The id value for this operation. Its accepted type and constraints are listed above and below.
couponIduuidRequired
Coupon UUID in the current App and environment.
statusenumRequired
The status value for this operation. Its accepted type and constraints are listed above and below.
Show allowed values
"issued""reserved""redeemed""revoked""expired"
issuedAtdate-timeRequired
The issuedAt value for this operation. Its accepted type and constraints are listed above and below.
expiresAtdate-timeRequired
ISO 8601 UTC expiry. Expired sessions and reservations cannot be reused.
couponobjectRequired
The coupon value for this operation. Its accepted type and constraints are listed above and below.
Show child fields
namestringRequired
Display name of the customer or object; not an identity key.
discountobject | objectRequired
The discount value for this operation. Its accepted type and constraints are listed above and below.
Show child fields
type"percent" | "amount"Required
The type value for this operation. Its accepted type and constraints are listed above and below.
percentOffintegerOptional
The percentOff value for this operation. Its accepted type and constraints are listed above and below.
min: 1 · max: 100
amountOffCentsintegerOptional
The amountOffCents value for this operation. Its accepted type and constraints are listed above and below.