Skip to main content
The Order object is created each time a subscription is billed or fulfilled, capturing the complete details of that transaction. Orders contain information about the products or services being delivered, pricing, discounts applied, shipping details, and payment status.

Search query fields

FieldDescriptionType
idThe subscription identifier (accepts up to 20 subscription IDs)string

Reference

id
string
required
Minimum string length: 1
createdAt
string<date-time>
required
placedAt
null | string<date-time>
required
currencyCode
string
required
Required string length: 3
type
required
Available options:
checkout
paymentStatus
required
deprecated

DEPRECATED: use financialStatus instead. The proxy implementation backing GET /customer/v1/orders cannot reliably derive a refund/chargeback signal for one-time orders, so this field is hard-coded to "paid". Migrate consumers to financialStatus.

Available options:
paid
financialStatus
null | string
required
fulfillmentStatus
null | string
required
subtotal
null | number
required
Required range: x >= 0
shipping
null | number
required
Required range: x >= 0
totalPrice
null | number
required
Required range: x >= 0
taxesAmount
null | number
required
Required range: x >= 0
taxesIncluded
null | boolean
required
items
OrderItem · object[]
required
Minimum array length: 1
discounts
OrderDiscount · object[]
required
deliveryMethod
OrderDeliveryMethod · object
required
paymentMethod
null | OrderPaymentMethod · object
required
deprecated

DEPRECATED: the proxy implementation backing GET /customer/v1/orders cannot reliably derive the customer's stored payment method per order, so this field is always null.

note
null | string
required
customAttributes
object[]
required
subscriptionIds
string[]
required
Minimum string length: 1