plan.deactivated
Active plan flipped inactive.
When this fires
A plan is taken off sale through the REST API (POST /v1/projects/{project}/plans/{plan}/unpublish) or the publish_plan MCP tool; automatically when a pass series runs its last date; or when the free-plan entitlement sweep disables an unentitled zero-priced plan. The plan remains visible to existing subscribers and stays in the catalog, but new checkouts cannot select it. Deactivating from the creator dashboard does not emit this event.
The two shapes are disjoint. The publish-state path sends
data.planand nothing else; an automatically retired series sends the five flat keys and nodata.planobject. Branch on whetherdata.planordata.plan_idis present before reading any other field.
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.
Header Parameters
t=<unix seconds>,v1=<hex>: the HMAC-SHA256 of "<t>.<raw body>" under the endpoint's secret. Verify it before acting, and refuse a t more than 300 seconds from now. During a secret rotation a v0= signature under the previous secret may precede v1=.
The event's ULID, bare. The envelope's id is the same ULID prefixed evt_, so strip the prefix before comparing. Deduplicate on it: a retry carries the same id.
The event name, the same as the envelope's type.
Always application/json.
Always Subscriby-Webhooks/1.0.
Request Body
application/json
The signed JSON envelope posted to your endpoint.
TypeScript Definitions
Use the request body type in TypeScript.
The envelope every event is delivered in.
Response Body
Example Requests
/plan.deactivatedHow is this guide?