# Tarif und Kontingent lesen (https://developer.bimetrics.de/referenz/tarif/get-entitlement)

`GET https://app.bimetrics.de/api/entitlement/`

operationId: `getEntitlement` · Berechtigung (Scope): `read` · Bereich: Tarif

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

`Authorization: Bearer bm_…` (alternativ `X-API-KEY: bm_…`, nie beide zugleich).

### Beispiel

```sh
curl --fail-with-body "https://app.bimetrics.de/api/entitlement/" \
  -H "Authorization: Bearer $BIMETRICS_API_KEY"
```

### Antworten

| Status | Beschreibung | Inhalt |
| --- | --- | --- |
| 200 | Erfolg. | `application/json`: Entitlement |
| 400 | Ungültige Anfrage, z. B. ein ungültiger Filter (unbekannte Art `kind`, unbekanntes Attribut, `sort` nach einem Attribut mit `sortable: false`, `limit` < 0, `offset` > 1.000.000), eine ID, die keine UUID ist, oder ein Upload ohne gültige `X-Upload-Request-Id`, mit mehr als einer Datei oder einer Datei über 30 MiB. Code meist `BadRequest`. Anfrage korrigieren, nicht wiederholen. | `application/json`: Error |
| 401 | Kein gültiger Schlüssel: fehlt (`Unauthorized`), ist unbekannt, abgelaufen oder widerrufen oder wurde nicht in genau einem Header gesendet (`InvalidAPIKey`). Schlüssel prüfen, nicht wiederholen. Auch eine ID, die zu einer anderen Firma gehört, ergibt `401 Unauthorized`. | `application/json`: Error |
| 403 | Dem Schlüssel fehlt die Berechtigung für diese Route (`APIKeyPermissionDenied`), oder der Tarif der Firma enthält die API nicht (`APIUnavailable`). | `application/json`: Error |
| 413 | Die Anfrage ist zu groß (`APIRequestTooLarge`), siehe `x-bimetrics-limits`. | `application/json`: Error |
| 429 | Zu viele Anfragen (`APIRateLimit`). Nach `Retry-After` Sekunden wiederholen; einen Upload mit derselben `X-Upload-Request-Id`. (Header: Retry-After) | `application/json`: Error |
| 500 | Serverfehler (`Internal`; `APIUnavailable`, wenn der Schlüssel gerade nicht geprüft werden kann). Später wiederholen, einen Upload mit derselben `X-Upload-Request-Id`. | `application/json`: Error |

#### Felder der Antwort 200 (`Entitlement`)

| Feld | Typ | Beschreibung |
| --- | --- | --- |
| `active` | boolean | Der Tarif ist aktiv. |
| `addonCompanies` | integer | Zusätzlich gebuchte Firmen. |
| `creditsIncluded` | integer | Im Tarif enthaltene Credits. |
| `features` | PlanFeatures | Enthaltene Funktionen. |
| `limits` | PlanLimits | Grenzen des Tarifs. |
| `period` | EntitlementPeriod | Laufender Abrechnungszeitraum. |
| `tier` | string: `solo`, `team`, `scale`, `legacy`, `none` | Tarif. |
| `usage` | EntitlementUsage | Aktuelle Nutzung. |
| `usageScope` | string: `monthly`, `trial_total` | Bezug von `usage.documentsPeriod`: `monthly` je Monat, `trial_total` für die gesamte Testphase. |

Verschachtelte Schemas stehen vollständig in der OpenAPI-Beschreibung: https://app.bimetrics.de/api/openapi.json