Skip to navigation

Suspension and pause

How printing is stopped for a location, a customer or a whole organization, and what happens to waiting jobs.
View as Markdown

Why suspension exists

A customer may stop paying, or a hotel may close for the season. An organization needs a way to stop printing for that customer or location without deleting anything.

Three levels of suspension

LevelWho does itWhat happens
Location (pause)The organization, with POST /v1/locations/{location}/suspendEvery printer of the location is refused.
Customer (suspend)The organization, with POST /v1/customers/{customer}/suspendEvery printer of the customer is refused.
Organization (suspend)Tillcast, for example when an organization stops payingThe organization’s keys can read and cannot write: a write is 403 organization_suspended. People can still sign in to the dashboard and read.

Both calls need the customers:write scope, and a key limited to one customer cannot suspend: a suspension is the organization’s decision. POST .../reactivate on the same path undoes it. The dashboard has no screen for these yet.

A refused printer gets a bare HTTP 403 and prints nothing. Nothing needs to change on the printer. The printer object shows the status customer_suspended or location_suspended.

New and waiting jobs during suspension

  • Creating a job for a suspended customer or a paused location is refused with 409 customer_suspended or 409 location_suspended. A test print is refused the same way.
  • Jobs that were already queued are kept until they expire. A payment may have been missed by accident, so Tillcast does not throw them away. If access returns before they expire, the printers print them. Otherwise they become expired. See Jobs.
  • A job that the printer had already downloaded still finishes normally.
  • A retry of a create that was accepted before the suspension is answered from the first request, with 200. It is not turned into a 409. See Idempotency.

Resuming after suspension

Resuming a location or a customer removes the refusal. Nothing changes on the printer. The design expects the printer to connect again by itself.

How a printer behaves while it is refused, and how long it needs to reconnect afterwards, has not been measured on a device yet. Expect a short delay, and check the printer’s last_seen_at after you resume.