GET
/api/ordering/recurring/{id}Get a standing order
Retrieves a standing order by its identifier. Use this operation to inspect the template’s customer, schedule, active or paused state, and lines. The standing-order lines do not carry prices; prices are resolved when a generated order is confirmed.
idstringrequired
The identifier of the standing order to retrieve.
200Returns the standing-order object, including its customer, name, schedule, active or paused state, timestamps, and lines.
idstringoptional
customerIdstringoptional
customerNamestringoptional
namestringoptional
daysOfWeekarray<integer>optional
0 = Sunday … 6 = Saturday, ascending. Always at least one.
isActivebooleanoptional
pausedUntilstringoptional
Suppressed until this day, and it fires again ON it. Null while active, and null while paused indefinitely — an indefinite pause is what "stop" means for v1.
createdByIdstringoptional
Null once the person who created it is retired.
createdAtstringoptional
lastGeneratedAtstringoptional
A true instant, not a day. Null until the first fire.
linesarray<object>optional
warningstringoptional
Present only on a create/update response, and NEVER a block. Says that this customer already has an active standing order sharing a weekday, and/or that today's generation run has already passed so this occurrence will not fire automatically.
400Returned when the input is invalid; the `error` field describes the problem.
errorstringrequired
401Returned when the authenticated user is not signed in.
errorstringrequired
404Returned when the standing order is not found.
errorstringrequired
500Returned when an unexpected server error occurs.
errorstringrequired
Error handling
A 400 is returned when the input is invalid; a 401 is returned when the authenticated user is not signed in. A 404 is returned when the standing order is not found, and a 500 is returned for an unexpected server error. The id path parameter must identify an existing standing order.