Swagger Petstore - OpenAPI 3.0
PATCH/api/ordering/recurring/{id}/active

Pause or resume a standing order

Updates whether a standing order is active or paused. Set isActive to control the state and supply pausedUntil for a pause with an end date; omitting it while pausing creates an indefinite pause. Resuming revives only occurrences cancelled by the pause, and a timed pause resumes automatically on its pausedUntil date.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

1 parameter · 2 body fields
idstringrequired
The identifier of the standing order to pause or resume.

State change for a standing order. isActive is required; pausedUntil may be supplied when pausing.

isActivebooleanrequired
Whether the standing order is active. Set to false to pause it and true to resume it.
pausedUntilstringoptional
Date in ISO 8601 format (YYYY-MM-DD) through which the order is paused. Must be strictly after today; omit it for an indefinite pause.

6 status codes
200Returns the updated standing-order object, including its active or paused state and `pausedUntil` value.
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 input is invalid, including when `isActive` is missing or a supplied `pausedUntil` value fails validation.
errorstringrequired
401Returned when the authenticated user is not signed in.
errorstringrequired
403Returned when the authenticated user lacks the required department membership or role.
errorstringrequired
404Returned when the standing order is not found.
errorstringrequired
500Returned when an unexpected server error occurs.
errorstringrequired

Error handling

A 400 is returned for invalid input, including a missing isActive or a pausedUntil value that fails validation; a 401 is returned when the authenticated user is not signed in. A 403 is returned when the authenticated user lacks the required department membership or role, 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. isActive is required; when pausing with pausedUntil, provide an ISO 8601 date strictly after today. Omit pausedUntil for an indefinite pause.