Pause, resume, complete or cancel an order.
Each endpoint here moves an order to a new status and returns the updated order.
| Action | New status | When you can use it |
|---|---|---|
| Pause | paused | The order is a subscription with a card on file, and available_actions.pause is true. |
| Resume | active | The order is paused, and available_actions.resume is true. |
| Complete | complete | The order has a successful payment, isn't draft, and available_actions.complete is true. |
| Cancel | cancelled | Any order that isn't already complete or cancelled. |
Cancelling can't be undone. Cancelling or completing an order also cancels its upcoming scheduled payments. On a paused order, they stay paused and are never collected.