{
"id": "<string>",
"customerId": "<string>",
"currencyCode": "<string>",
"skipped": true,
"date": "2023-11-07T05:31:56Z",
"cycleIndex": 1,
"subtotal": 1,
"deliveryPrice": 1,
"deliveryAddress": {
"firstName": "<string>",
"lastName": "<string>",
"address1": "<string>",
"address2": "<string>",
"zip": "<string>",
"city": "<string>",
"countryCode": "<string>",
"provinceCode": "<string>",
"phone": "<string>",
"company": "<string>"
},
"paymentMethodId": "<string>",
"paymentMethod": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"items": [
{
"id": "<string>",
"title": "<string>",
"subtitle": "<string>",
"quantity": 2,
"price": 1,
"totalPrice": 1,
"skipped": true,
"variant": "<string>",
"product": "<string>",
"subscription": "550e8400-e29b-41d4-a716-446655440000",
"subscriptionItem": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"parentProductId": "<string>",
"parentLineId": "<string>",
"recurringCycleLimit": 2,
"customAttributes": [
{
"key": "<string>",
"value": "<string>"
}
]
}
],
"discounts": [
{
"id": "<string>",
"title": "<string>",
"value": {
"type": "percentage",
"percentage": 50
},
"entitledItems": {
"all": true
},
"subscriptionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
]
}Schedules
Schedule order resource
This object represents an order within a schedule.
The
ScheduleOrder object is a projected future order generated by the schedule system. Each schedule contains one or more orders that define when and what will be delivered to the customer. Schedule orders serve as a preview of upcoming orders before they are actually created and processed, containing information about the delivery date, items to be delivered, pricing, discounts, and whether the order has been skipped.
Search query fields
| Field | Description | Type |
|---|---|---|
| id | The subscription identifier (accepts up to 20 subscription IDs) | string |
Reference
Minimum string length:
1Minimum string length:
1Required string length:
3Required range:
x >= 0Required range:
x >= 0Required range:
x >= 0Show child attributes
Show child attributes
Minimum string length:
1CustomerPaymentMethod id when not expanded, or the full CustomerPaymentMethod object when the field name is included in the expand query parameter. Can be null.
Minimum array length:
1Show child attributes
Show child attributes
Show child attributes
Show child attributes