Skip to main content
GET
Check a coupon code

Authorizations

Authorization
string
header
required

Send either an API token or an OAuth access token as Authorization: Bearer <token>. See the Authentication page for details.

Headers

Privy-Account-Id
string

Target a subaccount instead of the main connected account. Pass a subaccount id from get_account's subaccounts list. Only direct subaccounts of the connected account are reachable — omit this for the main account itself.

Path Parameters

id
string
required

The coupon pool's unique identifier (returned as id in coupon responses). Ids are opaque public strings — a numeric id from a Privy dashboard URL is not a valid API id and will 404; list coupons and match by title instead.

code
string
required

The coupon code to check, URL-encoded. Matched case-insensitively.

Response

The code's store-side usage status.

data
object
note
string

Fixed caveat that this is a usage counter, not an event log.