access_code.expired
Code passes expiry without redemption.
When this fires
An access code passes its expiry without being redeemed and is marked unusable.
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.expired",
"created_at": "2026-08-18T00:00:30Z",
"api_version": "2026-05-01",
"project_id": "prj_01HX...",
"data": {
"subscription_id": null,
"plan_id": "pln_01HX...",
"access_code": "masked_xxxxx",
"expires_at": "2026-08-18T00:00:00Z"
}
}Field reference
| Field | Type | Notes |
|---|---|---|
id | string ULID | Unique event id, prefixed evt_. Use for idempotent processing. |
type | string | Always access_code.expired 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 | null | Subscription tied to the code; null for codes that were never redeemed. |
data.plan_id | string ULID | Plan the code was scoped to. |
data.access_code | string | Masked code — last 5 characters revealed for CSV reconciliation. |
data.expires_at | ISO 8601 timestamp | When the code became unredeemable. |
Caveats
- Large batches may produce a sustained burst of
access_code.expiredevents when the batch hits its expiry. Plan capacity accordingly. - Codes that were already redeemed do not produce this event regardless of the batch's
expires_at.
Related events
access_code.redeemed— alternative outcome.access_code.generated— predecessor (batch-level).- Access code events overview — back to family overview.
How is this guide?