stopped: The budget was stopped

The owner used the emergency stop on the whole budget. In freeze mode every stream is frozen and can be resumed; in revoke mode every stream is revoked for good. Signed work stays settleable either way.

This code answers spending on a stream the stop froze, asking for an allowance credential for such a stream, and opening a new top-level stream on the budget while the stop holds: until the owner thaws the frozen streams (freeze mode), or for good (revoke mode). Streams a revoke stop revoked answer revoked instead.

What to do

On the wire

HTTP 409, error type halted.

A client that does not send Dynamo-Error-Detail: 1 to a 1.3.0 route sees the legacy reason revoked, so its response shape is unchanged. Opted-in clients and the 1.4.0 routes see stopped.

With Dynamo-Error-Detail: 1:

{
  "error": "halted",
  "reason": "stopped",
  "streamId": "stm_…",
  "detail": "…",
  "errorDetail": {
    "type": "halted",
    "code": "stopped",
    "message": "…",
    "param": null,
    "doc_url": "…/errors/stopped.md",
    "fix": "the budget was stopped by its owner; thaw the streams (freeze mode) or open a new budget (revoke mode)"
  }
}

See all error codes.