Get service status

---

title: Get the service status

Check whether the service is ready to use, in one read-only call; works with no issuer and takes no issuer selection. Returns {service: {status: available|interrupted, message?}, setup: {complete, issues: [missing_issuer | missing_csd | incomplete_theming, each with where it is resolved: missing_issuer carries setup_url, the page where the user registers their issuer and uploads its CSD (register_issuer also creates the issuer; its CSD is then uploaded in the browser), missing_csd carries upload_url, the page where the CSD is uploaded in the browser]}, balance: {billing: on, balance, currency, stamp_price, stamp_currency, stamps_affordable (the folios left), bonuses (top-up bonus tiers)} or {billing: off}, notifications: [{id, severity, message}]}. Nothing can be issued (created, updated or signed: an invoice, credit note or payment complement) while service.status is interrupted or setup.issues has a missing_issuer or missing_csd, and nothing can be signed while the balance does not cover a stamp. notifications are the service's current notices, and setup lists what is left to set up.

Alcance (scope): issuers:read · Características: Solo lectura, Idempotente

Parámetros

Sin parámetros.

Esquema de entrada (JSON Schema)

{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}