| Field | Type | Required | Description | Example |
|---|---|---|---|---|
ID |
string | ✔️ | The ID of the object. | |
CreatedAt |
time.Time | ✔️ | Creation timestamp of the object. | |
ModifiedAt |
time.Time | ✔️ | Last modification timestamp of the object. | |
Status |
components.OrderStatus | ✔️ | N/A | |
Paid |
bool | ✔️ | Whether the order has been paid for. | true |
SubtotalAmount |
int64 | ✔️ | Amount in cents, before discounts and taxes. | |
DiscountAmount |
int64 | ✔️ | Discount amount in cents. | |
NetAmount |
int64 | ✔️ | Amount in cents, after discounts but before taxes. | |
Amount |
int64 | ✔️ | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible. Amount in cents, after discounts but before taxes. |
|
TaxAmount |
int64 | ✔️ | Sales tax amount in cents. | |
TotalAmount |
int64 | ✔️ | Amount in cents, after discounts and taxes. | |
RefundedAmount |
int64 | ✔️ | Amount refunded in cents. | |
RefundedTaxAmount |
int64 | ✔️ | Sales tax refunded in cents. | |
Currency |
string | ✔️ | N/A | |
BillingReason |
components.OrderBillingReason | ✔️ | N/A | |
BillingAddress |
components.Address | ✔️ | N/A | |
CustomerID |
string | ✔️ | N/A | |
ProductID |
string | ✔️ | N/A | |
DiscountID |
string | ✔️ | N/A | |
SubscriptionID |
string | ✔️ | N/A | |
CheckoutID |
string | ✔️ | N/A | |
Metadata |
map[string]components.OrderMetadata | ✔️ | N/A | |
CustomFieldData |
map[string]components.OrderCustomFieldData | ➖ | Key-value object storing custom field values. | |
Customer |
components.OrderCustomer | ✔️ | N/A | |
UserID |
string | ✔️ | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible. | |
Product |
components.OrderProduct | ✔️ | N/A | |
Discount |
components.OrderDiscount | ✔️ | N/A | |
Subscription |
components.OrderSubscription | ✔️ | N/A | |
Items |
[]components.OrderItemSchema | ✔️ | Line items composing the order. |