created_atstring date-time required
Creation timestamp of the object.
modified_atstring date-time nullable required
Last modification timestamp of the object.
status'draft' | 'pending' | 'paid' | 'refunded' | 'partially_refunded' | 'void' required
paidboolean required
Whether the order has been paid for.
subtotal_amountinteger required
Amount in cents, before discounts and taxes.
discount_amountinteger required
Discount amount in cents.
net_amountinteger required
Amount in cents, after discounts but before taxes.
tax_amountinteger required
Sales tax amount in cents.
total_amountinteger required
Amount in cents, after discounts and taxes.
applied_balance_amountinteger required
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.
due_amountinteger required
Amount in cents that is due for this order.
refunded_amountinteger required
Amount refunded in cents.
refunded_tax_amountinteger required
Sales tax refunded in cents.
billing_reason'purchase' | 'subscription_create' | 'subscription_cycle' | 'subscription_update' required
billing_namestring nullable required
The name of the customer that should appear on the invoice.
invoice_numberstring nullable required
The invoice number associated with this order. null while the order is in draft status; assigned at finalize.
is_invoice_generatedboolean required
Whether an invoice has been generated for this order.
receipt_numberstring nullable required
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.
seatsinteger nullable
Number of seats purchased (for seat-based one-time orders).
customer_idstring uuid4 required
product_idstring uuid4 nullable required
discount_idstring uuid4 nullable required
subscription_idstring uuid4 nullable required
checkout_idstring uuid4 nullable required
next_payment_attempt_atstring date-time nullable
When the next automatic payment retry is scheduled. null if the order is not in dunning or all retries have been exhausted.
descriptionstring required
A summary description of the order.
refundable_amountinteger required
Amount in cents that can still be refunded (net, before taxes). Accounts for any applied customer balance and previous refunds.
refundable_tax_amountinteger required
Sales tax in cents that would be refunded if the full refundable amount is refunded.