plan.deactivated
Active plan flipped inactive.
When this fires
A creator deactivates a plan. It remains visible to existing subscribers and stays in the catalog, but new checkouts cannot select it.
Required ability
project-subscription-plan:view-any — token must carry this at mint time to subscribe an endpoint to this event.
Payload
{
"id": "evt_01HX...",
"type": "plan.deactivated",
"created_at": "2026-05-18T10:05:00Z",
"api_version": "2026-05-01",
"project_id": "prj_01HX...",
"data": {
"plan": {
"id": "pln_01HX...",
"active": false
}
}
}Field reference
| Field | Type | Notes |
|---|---|---|
id | string ULID | Unique event id, prefixed evt_. Use for idempotent processing. |
type | string | Always plan.deactivated 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.plan.id | string ULID | Plan identifier. |
data.plan.active | boolean | Always false for this event. |
Caveats
- Existing subscriptions on the plan are unaffected and continue to renew until cancelled or expired.
- For permanent removal use
plan.deleted.
Related events
plan.activated— paired transition.plan.deleted— terminal state.- Plan events overview — back to family overview.
How is this guide?