Status
: string
in package
Allowed wire values for order status.
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.
- Paid = 'paid'
- Payment completed successfully.
- Preparing = 'preparing'
- Selects the `preparing` API value for order status.
- RequiresPayment = 'requires_payment'
- Selects the `requires_payment` API value for order status.
- Unknown = 'unknown'
- The API could not classify the value more specifically.
Cases
Preparing
Selects the `preparing` API value for order status.
Wire value: preparing.
RequiresPayment
Selects the `requires_payment` API value for order status.
Wire value: requires_payment.
Paid
Payment completed successfully.
Wire value: paid.
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.
Unknown
The API could not classify the value more specifically.
Wire value: unknown.