Order class final

An order, its customer, line items, payment, and issued documents.

status describes the order lifecycle. Payment-specific state remains on payment, while invoice and the payment receipt describe customer-facing documents when the API has created them.

Available extensions

Constructors

Order({DateTime? canceledAt, CheckoutSettings? checkoutSettings, DateTime? completedAt, CreatedFrom? createdFrom, CustomData? customData, required Customer customer, DateTime? expiresAt, required String id, required DateTime initiatedAt, Invoice? invoice, String? number, String? receiptNumber, List<Refund>? refunds, InvoiceSettings? invoiceSettings, required Status status, DateTime? sealedAt, LineItemGroup? lineItemGroup, Payment? payment, DateTime? paidAt, DateTime? paymentDueAt, String? reference})
const
Order.fromJson(Map<String, Object?> json)
factory

Properties

canceledAt → DateTime?
final
checkoutSettings → CheckoutSettings?
final
completedAt → DateTime?
final
createdFrom → CreatedFrom?
final
customData → CustomData?
final
customer → Customer
final
expiresAt → DateTime?
final
hashCode → int
The hash code for this object.
no setterinherited
id → String
final
initiatedAt → DateTime
final
invoice → Invoice?
final
invoiceSettings → InvoiceSettings?
final
isPaid → bool

Available on Order, provided by the OrderSemantics extension

no setter
isTerminal → bool

Available on Order, provided by the OrderSemantics extension

no setter
lineItemGroup → LineItemGroup?
final
number → String?
final
paidAt → DateTime?
final
payment → Payment?
final
paymentDueAt → DateTime?
final
receiptNumber → String?
final
reference → String?
final
refunds → List<Refund>?
final
requiredPaymentAction → NextAction?

Available on Order, provided by the OrderSemantics extension

no setter
requiresPayment → bool

Available on Order, provided by the OrderSemantics extension

no setter
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
sealedAt → DateTime?
final
status → Status
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toJson() → Map<String, Object?>
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited