Query coupon status and sanitized metadata

Returns non-PII metadata for a coupon (no userId/profileId). projectId is required as a query parameter and must match the key’s project.

Auth: X-API-Key with scope coupon:read (x-required-scope: coupon:read).

Authorizations

• ApiKeyAuth

Parameters

Path Parameters

code

required

string

The coupon code to look up.

Query Parameters

projectId

required

string

Project that owns the coupon (must match the API key’s project).

Responses

200

Coupon metadata.

Media typeapplication/json

object

status

required

string

form

required

Coupon form/type.

string

poolId

required

string

expiresAt

required

string | null format: date-time

redeemedAt

Present only when the coupon has been redeemed.

string format: date-time

401

Missing/invalid API key.

Media typeapplication/json

object

error

required

Human-readable error message.

string

retryAfter

Seconds to wait before retrying (present on 429/503).

integer

message

string

affectedIndices

Array<integer>

Example^generated

json

{
  "error": "example",
  "retryAfter": 1,
  "message": "example",
  "affectedIndices": [
    1
  ]
}

403

API key lacks the coupon:read scope.

Media typeapplication/json

object

error

required

Human-readable error message.

string

retryAfter

Seconds to wait before retrying (present on 429/503).

integer

message

string

affectedIndices

Array<integer>

Example^generated

json

{
  "error": "example",
  "retryAfter": 1,
  "message": "example",
  "affectedIndices": [
    1
  ]
}

404

Coupon not found, or cross-tenant (same shape).

Media typeapplication/json

object

error

required

Human-readable error message.

string

retryAfter

Seconds to wait before retrying (present on 429/503).

integer

message

string

affectedIndices

Array<integer>

Example

json

{
  "error": "not_found"
}