bimetricsEntwickler
Tarif

Tarif und Kontingent lesen

Als Markdown ansehen

Benötigte Berechtigung:read(Daten lesen)

GET
/api/entitlement/

Liefert Tarif, Grenzen und die aktuelle Nutzung der Firma. Ein einfacher erster Aufruf, um Schlüssel und Verbindung zu prüfen.

Benötigt einen Schlüssel mit der Berechtigung read.

Authentifizierung

headerAuthentifizierungBearer <bm_…>

Empfohlen: Authorization: Bearer bm_…. Der Schlüssel wird nur einmal angezeigt; nie in URLs, Logs oder Frontend-Code ablegen.

Antworten

Erfolg.

application/json
  1. response

Tarif, Grenzen und Nutzung der Firma.

active?boolean

Der Tarif ist aktiv.

addonCompanies?integer

Zusätzlich gebuchte Firmen.

creditsIncluded?integer

Im Tarif enthaltene Credits.

features?

Enthaltene Funktionen.

limits?

Grenzen des Tarifs.

period?

Laufender Abrechnungszeitraum.

tier?string

Tarif.

Wert in"solo""team""scale""legacy""none"
usage?

Aktuelle Nutzung.

usageScope?string

Bezug von usage.documentsPeriod: monthly je Monat, trial_total für die gesamte Testphase.

Wert in"monthly""trial_total"
Beispielanfrage
curl --fail-with-body "https://app.bimetrics.de/api/entitlement/" \  -H "Authorization: Bearer $BIMETRICS_API_KEY"
Beispielantwort
{  "active": true,  "addonCompanies": 0,  "creditsIncluded": 0,  "features": {    "bimiBot": false,    "mcp": false,    "prioritySupport": true,    "rules": true  },  "limits": {    "bankAccounts": 10,    "companies": 5,    "documents": 3000,    "users": 10  },  "period": {    "end": "2026-10-01T00:00:00Z",    "start": "2026-09-01T00:00:00Z"  },  "tier": "team",  "usage": {    "bankAccounts": 1,    "companies": 1,    "creditsBalance": 0,    "documentsPeriod": 212,    "generatedInvoicesPeriod": 0,    "invoicesCounted": false,    "processedDocumentsPeriod": 212,    "users": 2  },  "usageScope": "monthly"}