| Field | Type | Required | Description | Example |
|---|---|---|---|---|
created_at |
date | ✔️ | Creation timestamp of the object. | |
modified_at |
date | ✔️ | Last modification timestamp of the object. | |
id |
str | ✔️ | The ID of the object. | |
metadata |
Dict[str, models.OrderMetadata] | ✔️ | N/A | |
custom_field_data |
Dict[str, Nullable[models.OrderCustomFieldData]] | ➖ | Key-value object storing custom field values. | |
status |
models.OrderStatus | ✔️ | N/A | |
paid |
bool | ✔️ | Whether the order has been paid for. | true |
subtotal_amount |
int | ✔️ | Amount in cents, before discounts and taxes. | |
discount_amount |
int | ✔️ | Discount amount in cents. | |
net_amount |
int | ✔️ | Amount in cents, after discounts but before taxes. | |
amount |
int | ✔️ | : 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. |
|
tax_amount |
int | ✔️ | Sales tax amount in cents. | |
total_amount |
int | ✔️ | Amount in cents, after discounts and taxes. | |
refunded_amount |
int | ✔️ | Amount refunded in cents. | |
refunded_tax_amount |
int | ✔️ | Sales tax refunded in cents. | |
currency |
str | ✔️ | N/A | |
billing_reason |
models.OrderBillingReason | ✔️ | N/A | |
billing_address |
Nullable[models.Address] | ✔️ | N/A | |
customer_id |
str | ✔️ | N/A | |
product_id |
str | ✔️ | N/A | |
discount_id |
Nullable[str] | ✔️ | N/A | |
subscription_id |
Nullable[str] | ✔️ | N/A | |
checkout_id |
Nullable[str] | ✔️ | N/A | |
customer |
models.OrderCustomer | ✔️ | N/A | |
user_id |
str | ✔️ | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible. | |
product |
models.OrderProduct | ✔️ | N/A | |
discount |
Nullable[models.OrderDiscount] | ✔️ | N/A | |
subscription |
Nullable[models.OrderSubscription] | ✔️ | N/A | |
items |
List[models.OrderItemSchema] | ✔️ | Line items composing the order. |