{
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"placedAt": "2023-11-07T05:31:56Z",
"currencyCode": "<string>",
"financialStatus": "<string>",
"paidAt": "2023-11-07T05:31:56Z",
"fulfillmentStatus": "<string>",
"subtotal": 1,
"shipping": 1,
"totalPrice": 1,
"taxesAmount": 1,
"taxesIncluded": true,
"items": [
{
"id": "<string>",
"title": "<string>",
"subtitle": "<string>",
"quantity": 2,
"unitPrice": 1,
"totalPrice": 1,
"productId": "<string>",
"variantId": "<string>",
"sku": "<string>",
"variantImage": {
"url": "<string>",
"altText": "<string>"
},
"subscriptionLineId": "<string>",
"requiresShipping": true,
"taxable": true,
"customAttributes": [
{
"key": "<string>",
"value": "<string>"
}
],
"sellingPlanId": "<string>",
"sellingPlanName": "<string>"
}
],
"discounts": [
{
"id": "<string>",
"title": "<string>",
"value": {
"type": "Percentage",
"percentage": 50
},
"entitledItems": {
"all": true
},
"subscriptionDiscountId": "<string>"
}
],
"deliveryMethod": {
"type": "Shipping",
"address": {
"firstName": "<string>",
"lastName": "<string>",
"address1": "<string>",
"address2": "<string>",
"zip": "<string>",
"city": "<string>",
"country": "<string>",
"countryCode": "<string>",
"provinceCode": "<string>",
"province": "<string>",
"phone": "<string>",
"company": "<string>"
}
},
"paymentMethod": {
"id": "<string>",
"details": {
"brand": "<string>",
"lastDigits": "<string>",
"maskedNumber": "<string>",
"expiryMonth": 6,
"expiryYear": 2001,
"name": "<string>"
}
},
"note": "<string>",
"customAttributes": [
{
"key": "<string>",
"value": "<string>"
}
],
"subscriptionIds": [
"<string>"
]
}Order resource
This object represents an individual transaction within a subscription.
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
13recurring is a scheduled renewal order, checkout the order that created the subscription, and instant a one-off purchase the customer made outside the schedule (an instant order) — it carries no billing cycle.
checkout, recurring, instant DEPRECATED: use financialStatus instead. For a postpaid invoice, this carries the invoice's own payment lifecycle (unpaid / overdue / paid), whether or not it already has a Shopify order. For any other tracked order, it's derived from the order's billing attempt (chargeback / refund / paid). Genuine one-time orders we never tracked default to "paid", since this proxy implementation cannot reliably derive a refund/chargeback signal for those. Migrate consumers to financialStatus.
paid, refund, chargeback, unpaid, overdue When the order was paid in full, or null if it never was. paidAt != null is therefore safe to read as "this order is paid": an order that is only partially paid, authorized but uncaptured, pending or abandoned reports null, never a partial date. A refunded or partially refunded order keeps its date, because it was paid in full and the money went back afterwards — financialStatus is what tells you that happened.
Shopify's Order exposes no such field, so this is derived: the earliest successful SALE/CAPTURE transaction on the Shopify order, falling back to the order's billing attempt (processedAt, else completedAt) when Shopify records no successful capture — the case for an invoice collected off-Shopify by Stripe/Mollie, and the only source at all for an invoice with no Shopify order yet.
x >= 0x >= 0x >= 0x >= 01Show child attributes
Show child attributes
Show child attributes
Show child attributes
- OrderDeliveryMethod
- OrderDeliveryMethod
- OrderDeliveryMethod
Show child attributes
Show child attributes
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.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Ids of the Juo subscriptions this order belongs to — the same id space as GET /customer/v1/subscriptions, so these join directly against a subscription resource. Empty for a one-time order. Resolved from the order's own subscription links where we track the order, and otherwise by mapping each line item's Shopify subscription contract back to Subscription.externalId; a contract with no subscription of ours behind it is omitted rather than reported under its Shopify id.
1