Overview
See what a customer bought, how they paid, and what happened to the order.
An order tracks a purchase as a whole: the customer, payment state, payment-provider summary, totals, and status timeline. Its line items describe each purchased product variant.
For new integrations that read purchase state, use /v2/orders. Its line_items preserve product-level sale details. The existing /v2/invoices endpoints remain available for compatibility.
Use an API key with the invoice ability or an OAuth access token with
orders:read for reads and orders:write for mutations. Send X-STORE to select
the store. The account's current store permissions also apply.
Endpoints
Amounts and privacy
All totals are integer minor units. For example, 1000 represents $10.00 when currency is USD.
Order read responses provide customer and payment summaries without raw payment-provider payloads or credentials. Creation and checkout responses can include a checkout URL; treat it as sensitive and share it only with the intended customer.