Access codes

Redeem Code

Changed on

Apply a code to the signed-in account.

Response: outcome (granted | link_required | discount_handoff | attributed), policy, tier, starts_at, ends_at, link_required, already_subscribed, attribution_recorded, checkout (discounts: the hand-off into the existing Stripe checkout — see access_codes.discount_handoff).

Refusals are 4xx with detail={"code", "message"}; code is stable: invalid 404 · expired 410 · used 409 · revoked 410 · cap_reached 409 · already_redeemed 409 · paused 423 · adviser_unavailable 503 · web_only 403.

post/api/codes/redeem

Request

  • Base URL: https://api.earmarkiq.app (the document declares no server; this is the origin it was published from)
  • URL: https://api.earmarkiq.app/api/codes/redeem
  • Auth: HTTP bearer

Request body

codestring required

Response

Successful Response

unknown required

Changes