subscription.cancelled
Cancellation recorded; access continues until ends_at.
When this fires
Cancellation is recorded by the subscriber or creator. The subscription remains active and the subscriber retains access until ends_at; after that, subscription.expired fires.
Required ability
project-subscription:view-any — token must carry this at mint time to subscribe an endpoint to this event.
Payload
{
"id": "evt_01HX...",
"type": "subscription.cancelled",
"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...",
"provider": "stripe"
}
}Field reference
| Field | Type | Notes |
|---|---|---|
id | string ULID | Unique event id, prefixed evt_. Use for idempotent processing. |
type | string | Always subscription.cancelled 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 identifier. |
data.plan_id | string ULID | Plan the subscription is on. |
data.subscriber_id | string ULID | Subscriber's project-scoped user id. |
data.provider | string | Payment provider slug or access_code. |
Caveats
- Cancellation is reversible until
ends_at— seesubscription.reactivated. - A renewal does not occur after cancellation;
subscription.renewedwill not fire.
Related events
subscription.expired— fires when the period ends.subscription.reactivated— reverse path.- Subscription events overview — back to family overview.
How is this guide?