access_code.redeemed

When this fires

A subscriber successfully redeems an access code. The code is marked consumed and a subscription is created on the associated plan.

Required ability

project-access-code:view-any — token must carry this at mint time to subscribe an endpoint to this event.

Payload

{
  "id": "evt_01HX...",
  "type": "access_code.redeemed",
  "created_at": "2026-05-18T10:05:00Z",
  "api_version": "2026-05-01",
  "project_id": "prj_01HX...",
  "data": {
    "subscription_id": "sub_01HX...",
    "plan_id": "pln_01HX...",
    "subscriber_id": "usr_01HX...",
    "access_code": "masked_xxxxx"
  }
}

Field reference

Field	Type	Notes
`id`	string ULID	Unique event id, prefixed `evt_`. Use for idempotent processing.
`type`	string	Always `access_code.redeemed` for this event.
`created_at`	ISO 8601 timestamp	Server-side emission time.
`api_version`	string	Webhook API contract version.
`project_id`	string ULID	Project this event belongs to.
`data.subscription_id`	string ULID	Subscription created by the redemption.
`data.plan_id`	string ULID	Plan the code was scoped to.
`data.subscriber_id`	string ULID	Subscriber's project-scoped user id.
`data.access_code`	string	Masked code — last 5 characters revealed for CSV reconciliation.

Caveats

Use the masked code for matching against your bulk-generate CSV export, not for triggering further redemptions.
Pairs with subscription.created and member.joined.

access_code.generated — predecessor (batch-level).
access_code.expired — alternative outcome.
Access code events overview — back to family overview.