Early bird discounts live! Claim your offer

subscription.paused

A member's access was suspended. Billing is unaffected and continues on schedule.

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 Telegram resource.

This is an access pause, not a billing pause. The member's payment provider keeps charging them on schedule — Subscriby does not call 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.

Required ability

project-subscription:view — 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": "7f3d1c92-8b45-4e6a-9d21-5c8e0a4b6f13",
  "data": {
    "subscription_id": "5b7e2d40-1a86-4c39-97f2-e83d0b16c5a4",
    "plan_id": "c4e82f16-93a7-4d5b-b81c-6e0f27a94d3b",
    "subscriber_id": "2a91c4e7-6f38-4b52-8e0d-9c1a7b3f5d80",
    "paused_at": "2026-05-18T10:05:00Z"
  }
}

Field reference

FieldTypeNotes
idstring ULIDUnique event id, prefixed evt_. Use for idempotent processing.
typestringAlways subscription.paused for this event.
created_atISO 8601 timestampServer-side emission time.
api_versionstringWebhook API contract version.
project_idstring UUIDProject this event belongs to.
data.subscription_idstring UUIDSubscription identifier.
data.plan_idstring UUIDPlan the subscription is on.
data.subscriber_idstring UUIDSubscriber's project-scoped user id.
data.paused_atISO 8601 timestampWhen the pause took effect.

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.

How is this guide?

On this page

Subscriby is a product designed by you — for you.

No boardroom full of executives deciding what we ships next. Our roadmap always shaped by you with your feedback.

Share feedback or a request