PUT /api/v1/orders/{order_id}/pause for an indefinite hold, or PUT /api/v1/orders/{order_id}/pause/{date} to hold until a calendar date, at which point the order unpauses itself. Both are valid only from received or exception.
Resuming
paused_until. It’s valid only from paused.
How the timed pause behaves
- The order automatically unpauses when that date arrives — you don’t need to call anything.
paused_untilisnullwhen the pause is indefinite, or when the order isn’t paused.- Calling pause-until again on an already-paused order updates the date rather than erroring.
What pausing does and doesn’t do
Pausing stops fulfillment. It does not cancel the order, release the prescription’s fills, or notify the patient. The order retains its line items and its prescription links, and picks up exactly where it left off.Pause an order
Indefinite hold
Pause an order until a date
Auto-unpauses on the date
Unpause an order
Restores the prior status
Cancel an order
When it shouldn’t ship at all