OrderStatus
: string
in package
Current status of the order.
Use enum cases in typed PHP code and ->value when building a native
request array. Each case maps exactly to the documented API string.
Table of Contents
Cases
- Canceled = 'canceled'
- The operation was canceled before successful completion.
- Completed = 'completed'
- The operation reached its completed state.
- Expired = 'expired'
- The value is no longer usable because its validity period ended.
- Preparing = 'preparing'
- Selects the `preparing` API value for checkout order status.
- RequiresPayment = 'requires_payment'
- Selects the `requires_payment` API value for checkout order status.
Cases
Preparing
Selects the `preparing` API value for checkout order status.
Wire value: preparing.
RequiresPayment
Selects the `requires_payment` API value for checkout order status.
Wire value: requires_payment.
Completed
The operation reached its completed state.
Wire value: completed.
Canceled
The operation was canceled before successful completion.
Wire value: canceled.
Expired
The value is no longer usable because its validity period ended.
Wire value: expired.