Order

Fields

Field	Type	Required	Description	Example
id	str	:heavy_check_mark:	The ID of the object.
created_at	date	:heavy_check_mark:	Creation timestamp of the object.
modified_at	date	:heavy_check_mark:	Last modification timestamp of the object.
status	models.OrderStatus	:heavy_check_mark:	N/A
paid	bool	:heavy_check_mark:	Whether the order has been paid for.	true
subtotal_amount	int	:heavy_check_mark:	Amount in cents, before discounts and taxes.	10000
discount_amount	int	:heavy_check_mark:	Discount amount in cents.	1000
net_amount	int	:heavy_check_mark:	Amount in cents, after discounts but before taxes.	9000
tax_amount	int	:heavy_check_mark:	Sales tax amount in cents.	720
total_amount	int	:heavy_check_mark:	Amount in cents, after discounts and taxes.	9720
applied_balance_amount	int	:heavy_check_mark:	Customer's balance amount applied to this invoice. Can increase the total amount paid, if the customer has a negative balance, or decrease it, if the customer has a positive balance.Amount in cents.	0
due_amount	int	:heavy_check_mark:	Amount in cents that is due for this order.	0
refunded_amount	int	:heavy_check_mark:	Amount refunded in cents.	0
refunded_tax_amount	int	:heavy_check_mark:	Sales tax refunded in cents.	0
currency	str	:heavy_check_mark:	N/A	usd
billing_reason	models.OrderBillingReason	:heavy_check_mark:	N/A
billing_name	Nullable[str]	:heavy_check_mark:	The name of the customer that should appear on the invoice.
billing_address	Nullable[models.Address]	:heavy_check_mark:	N/A
invoice_number	Nullable[str]	:heavy_check_mark:	The invoice number associated with this order. null while the order is in draft status; assigned at finalize.
is_invoice_generated	bool	:heavy_check_mark:	Whether an invoice has been generated for this order.
receipt_number	Nullable[str]	:heavy_check_mark:	The receipt number for this order. Set once the order is paid for organizations with receipts enabled. When set, a downloadable receipt PDF can be obtained via the receipt endpoint.
seats	OptionalNullable[int]	:heavy_minus_sign:	Number of seats purchased (for seat-based one-time orders).
customer_id	str	:heavy_check_mark:	N/A
product_id	Nullable[str]	:heavy_check_mark:	N/A
discount_id	Nullable[str]	:heavy_check_mark:	N/A
subscription_id	Nullable[str]	:heavy_check_mark:	N/A
checkout_id	Nullable[str]	:heavy_check_mark:	N/A
metadata	Dict[str, models.MetadataOutputType]	:heavy_check_mark:	N/A
custom_field_data	Dict[str, Nullable[models.OrderCustomFieldData]]	:heavy_minus_sign:	Key-value object storing custom field values.
platform_fee_amount	int	:heavy_check_mark:	Platform fee amount in cents.	500
platform_fee_currency	Nullable[str]	:heavy_check_mark:	Currency of the platform fee.	usd
customer	models.OrderCustomer	:heavy_check_mark:	N/A
product	Nullable[models.OrderProduct]	:heavy_check_mark:	N/A
discount	Nullable[models.OrderDiscount]	:heavy_check_mark:	N/A
subscription	Nullable[models.OrderSubscription]	:heavy_check_mark:	N/A
items	List[models.OrderItemSchema]	:heavy_check_mark:	Line items composing the order.
description	str	:heavy_check_mark:	A summary description of the order.	Pro Plan
refundable_amount	int	:heavy_check_mark:	Amount in cents that can still be refunded (net, before taxes). Accounts for any applied customer balance and previous refunds.	9000
refundable_tax_amount	int	:heavy_check_mark:	Sales tax in cents that would be refunded if the full refundable amount is refunded.	720