id |
str |
✔️ |
The ID of the object. |
|
created_at |
date |
✔️ |
Creation timestamp of the object. |
|
modified_at |
date |
✔️ |
Last modification timestamp of the object. |
|
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. |
10000 |
discount_amount |
int |
✔️ |
Discount amount in cents. |
1000 |
net_amount |
int |
✔️ |
Amount in cents, after discounts but before taxes. |
9000 |
tax_amount |
int |
✔️ |
Sales tax amount in cents. |
720 |
total_amount |
int |
✔️ |
Amount in cents, after discounts and taxes. |
9720 |
applied_balance_amount |
int |
✔️ |
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 |
✔️ |
Amount in cents that is due for this order. |
0 |
refunded_amount |
int |
✔️ |
Amount refunded in cents. |
0 |
refunded_tax_amount |
int |
✔️ |
Sales tax refunded in cents. |
0 |
currency |
str |
✔️ |
N/A |
usd |
billing_reason |
models.OrderBillingReason |
✔️ |
N/A |
|
billing_name |
Nullable[str] |
✔️ |
The name of the customer that should appear on the invoice. |
|
billing_address |
Nullable[models.Address] |
✔️ |
N/A |
|
invoice_number |
Nullable[str] |
✔️ |
The invoice number associated with this order. null while the order is in draft status; assigned at finalize. |
|
is_invoice_generated |
bool |
✔️ |
Whether an invoice has been generated for this order. |
|
receipt_number |
Nullable[str] |
✔️ |
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] |
➖ |
Number of seats purchased (for seat-based one-time orders). |
|
customer_id |
str |
✔️ |
N/A |
|
product_id |
Nullable[str] |
✔️ |
N/A |
|
discount_id |
Nullable[str] |
✔️ |
N/A |
|
subscription_id |
Nullable[str] |
✔️ |
N/A |
|
checkout_id |
Nullable[str] |
✔️ |
N/A |
|
metadata |
Dict[str, models.MetadataOutputType] |
✔️ |
N/A |
|
custom_field_data |
Dict[str, Nullable[models.OrderCustomFieldData]] |
➖ |
Key-value object storing custom field values. |
|
platform_fee_amount |
int |
✔️ |
Platform fee amount in cents. |
500 |
platform_fee_currency |
Nullable[str] |
✔️ |
Currency of the platform fee. |
usd |
customer |
models.OrderCustomer |
✔️ |
N/A |
|
product |
Nullable[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. |
|
description |
str |
✔️ |
A summary description of the order. |
Pro Plan |
refundable_amount |
int |
✔️ |
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 |
✔️ |
Sales tax in cents that would be refunded if the full refundable amount is refunded. |
720 |