Non-Breaking
Order Reason Support for Orders and Webhooks
·By eliasramos
New Order Reason Field
Connect API now supports an optional order_reason field for Orders and Order webhooks.
This field provides additional business context about why a specific order was created.
The new field is currently populated for:
- Quick transfer SIM swap flows on iOS
- Activation orders with porting
- Payment overdue flows for prepaid subscriptions
- Downgrade flows from voice plans to data-only plans
This enhancement improves observability for partners integrating advanced subscription lifecycle and recovery flows.
Supported Order Reasons
The following values are currently supported:
| Value | Description |
|---|---|
quick_transfer | Order created as part of a quick transfer SIM swap flow on iOS (Magnolia flow). |
porting | Order related to subscription activation with number porting. |
payment_overdue | Order triggered due to overdue payment scenarios in prepaid subscriptions. |
inactivity_downgrade | Order triggered during downgrade flows from voice plans to data-only plans. |
API and Webhook Changes
The Order resource and Order webhooks now support:
order_reason:
type: string
description: The Order reason
enum:
- quick_transfer
- porting
- payment_overdue
- inactivity_downgrade