Orders
Order resource
This object represents an individual transaction within a subscription.
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
| Field | Description | Type |
|---|---|---|
| id | The subscription identifier (accepts up to 20 subscription IDs) | string |
Reference
Minimum string length:
1Required string length:
3Available options:
checkout 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 Required range:
x >= 0Required range:
x >= 0Required range:
x >= 0Required range:
x >= 0Minimum array length:
1- OrderDeliveryMethod
- OrderDeliveryMethod
- OrderDeliveryMethod
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.
Minimum string length:
1