Payload

All webhook payloads follow a consistent top-level structure with event-specific data nested within the data object.

subscriptionIdstring

The paused subscription ID.

customerIdstring

The customer ID for the paused subscription.

status"paused"

The subscription status after pausing.

mode"immediate" | "period_end"

How the pause became effective.

effectiveAtstring

When the pause becomes or became effective.

resumeAtstring | null

When automatic resume is scheduled, or null when indefinite.

{
  "event": "subscription.paused",
  "timestamp": "2026-06-23T14:30:00.000Z",
  "organizationId": "8f14e45f-ceea-4e7a-9c3d-1c2b3a4d5e6f",
  "mode": "live",
  "apiVersion": "2026-08-27",
  "data": {
    "subscriptionId": "sub_1a2b3c4d",
    "customerId": "user_123",
    "status": "paused",
    "mode": "period_end",
    "effectiveAt": "2026-09-01T00:00:00.000Z",
    "resumeAt": "2026-09-15T00:00:00.000Z"
  }
}

Revoke access when this event arrives.