Skip to main content

Event: subscription.paused

Dispatched when a subscription is paused via API (PATCHpaused).

Schema definition

Loading ....
FieldValue on this event
reasonpause_reason (if provided)
effective_atpause_until (if provided)

Example

{
"event_type": "subscription.paused",
"subscription_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
"customer_id": "6ba7b810-9dad-11d1-80b4-00c04fd430c8",
"plan_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"merchant_id": "2e0b4f5a-8c3d-4e1f-9a2b-1c3d4e5f6a7b",
"status": "paused",
"reason": "customer_vacation",
"effective_at": "2026-08-01T00:00:00Z"
}