Order
Order object
Order
Order object
type OrderObject = {
object: "order"; // string literal
id: string; // uuid
number: string; // matches ^#?([0-9A-Za-z]{12,16}|[0-9]+)(-[0-9]+)?$
status: string; // one of "PENDING", "PAID", "FAILED", "UNPAID", "CANCELLED", "REFUNDED", "PARTIALLY_REFUNDED", "EXPIRED"
value: number; // integer value in the smallest currency unit, defaults to 0
tax: number; // integer value in the smallest currency unit, defaults to 0
fee: number; // integer value in the smallest currency unit, defaults to 0
currency: string; // ISO 4217 currency code
country: string; // ISO 3166-1 alpha-2 country code
currencyDecimals: number; // number of decimals in the currency
totalItems: number; // number of items in the order, defaults to 0
createdAt: number; // unix timestamp in milliseconds
userId: string; // uuid
user: UserObject;
// backwards compatibility
orderNumber: string; // matches ^#?([0-9A-Za-z]{12,16}|[0-9]+)(-[0-9]+)?$
};