subscription.paused

When this fires

A subscription is paused — billing is halted and the subscriber's resource access is revoked until it is unpaused.

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.paused",
  "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...",
    "paused_at": "2026-05-18T10:05:00Z"
  }
}

Field reference

Field	Type	Notes
`id`	string ULID	Unique event id, prefixed `evt_`. Use for idempotent processing.
`type`	string	Always `subscription.paused` 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.paused_at`	ISO 8601 timestamp	When the pause took effect.

Caveats

Pausing does not change ends_at. When unpaused via subscription.unpaused, the remaining period resumes.
resource_removed`](../member/resource-removed) to follow.

subscription.unpaused — paired transition.
Subscription events overview — back to family overview.