Skip to main content
POST
Redeem a promo code

Authorizations

Authorization
string
header
required

Monid API key (Authorization: Bearer mk_...) or Clerk-issued JWT. Each operation lists the ONE scope an API key needs. {resource}:* grants every action on that resource; * grants everything; Clerk sessions hold *. Operations with an empty list need no scope. Scope catalog: GET /v1/api-keys/scopes.

Headers

X-Monid-Agent-Model
string

Model driving the calling agent. Optional; a value that is empty, longer than 256 characters or not printable ASCII is ignored (never an error).

Maximum string length: 256
X-Monid-Agent-Harness
string

Agent harness or client making the call (e.g. a coding agent, an agent framework). Optional; a value that is empty, longer than 256 characters or not printable ASCII is ignored (never an error).

Maximum string length: 256
X-Monid-Agent-Session-Id
string

Caller-side session identifier, so the calls of one agent session (discover → inspect → run → polling) can be correlated. Optional; a value that is empty, longer than 256 characters or not printable ASCII is ignored (never an error).

Maximum string length: 256

Body

application/json
code
string
required

Promo code (normalized to uppercase before lookup).

Required string length: 1 - 64
Example:

"WELCOME10"

source
enum<string>

How the redemption was started, for telemetry only: link = auto-claimed from a ?promo= URL; omitted / manual = typed by the user. Both are handled identically.

Available options:
link,
manual
Example:

"manual"

Response

Promo code redeemed; balance refreshed

amount
number
required

Credited amount in dollars (float).

Example:

10

currency
string
required

ISO currency code of the credit.

Example:

"USD"

balance
object
required