subscription.paused

A member's access was suspended.

Ability to subscribeproject-subscription:view

When this fires

A creator suspended a member's access. payment_status becomes paused, paused_at is stamped, and the member is removed from every linked resource.

This is an access pause, not a billing pause. The member's payment provider keeps charging them on schedule. Subscriby does not pause collection, suspend the PayPal agreement, or otherwise hold the charge. If you need billing to stop, cancel instead.

The split is deliberate: Subscriby settles through seven providers and only some can hold a recurring charge at all, so a pause meaning "stop billing" would work on some providers and silently not on others. Access is something Subscriby controls directly, so it behaves identically everywhere.

Before 1 September 2026 this event fired without anything happening: no provider was called and no access was removed. If you built on the old behaviour, note that a paused member now genuinely loses access.

Caveats

  • Pausing does not change ends_at, and does not stop the clock. The member is still being billed, so a long pause costs them money for access they do not have. Tell them, or cancel instead.
  • Access removal is queued, one call per linked resource, so it completes shortly after this event rather than atomically with it.
  • Pausing does not detach resources, so no member.resource_removed events follow. Revocation happens only on expiry or cancellation.

Related events

  • subscription.unpaused: paired transition.

Header Parameters

SB-Signature*string

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=.

SB-Event-Id*string

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.

SB-Event-Name*string

The event name, the same as the envelope's type.

Content-Type*string

Always application/json.

User-Agent*string

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

POST/subscription.paused

How is this guide?