Subscription Paused

Fires when a subscription is placed on hold. The eventType is subscription_paused. Category: COMMERCE.

📘
v1 and v2 payloads are identical for commerce events.

Field guarantees

Field	Guarantee
`subscription_id`, `subscription_status`	✅ Always present
`total_value_cents`, `currency`	⚠️ Conditional — may be absent when the subscription has no amount/currency set

Payload (v1 and v2)

{
  "event_type": "subscription_paused",
  "api_version": "2026-08-09",
  "timestamp": "2026-05-26T12:00:00.000Z",
  "affiliate_id": "aff::example",
  "patient_id": "pat::example",
  "patient_external_id": "ext-patient-123",
  "patient_marketing_consent": true,
  "is_returning_patient": false,
  "subscription_id": "esub::example",
  "subscription_status": "on-hold",
  "total_value_cents": 4999,
  "currency": "usd"
}

Field	Type	Always?	Notes
`subscription_id`, `subscription_status`	string	✅
`total_value_cents`, `currency`	number/string	⚠️	Absent if the subscription has no amount/currency