Ecommerce Order Paid

Fires when an ecommerce order payment is collected. The eventType is ecommerce_order_paid. Categories: COMMERCE, PAYMENT.

📘

v1 and v2 payloads are identical for commerce events. These are commerce-native events built on the flat, sanitized payload shape — there is no separate raw-envelope form.

Field guarantees

FieldGuarantee
ecommerce_order_id, commerce_status, total_value_cents, currency✅ Always present
payment_status⚠️ Conditional

Payload (v1 and v2)

{
  "event_type": "ecommerce_order_paid",
  "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,
  "ecommerce_order_id": "eord::example",
  "commerce_status": "processing",
  "total_value_cents": 4999,
  "currency": "usd",
  "payment_status": "collected"
}
FieldTypeAlways?Notes
ecommerce_order_id, commerce_statusstring
total_value_cents, currencynumber/string
payment_statusstring⚠️e.g. collected