Skip to main content
GET
Traffic-Abrechnung abrufen

Authorizations

Authorization
string
header
required

Access-Token aus POST /auth/login (E-Mail und Passwort), gesendet als Authorization: Bearer <token>.

Das Token ist zeitlich begrenzt gültig. Mit dem refresh_token aus derselben Antwort holt POST /auth/token/refresh ein neues Token-Paar, ohne das Passwort erneut zu senden; POST /auth/token/invalidate macht den Refresh-Token beim Abmelden ungültig.

Ist für das Konto ein zweiter Faktor aktiv oder vorgeschrieben, liefert der Login statt des Token-Paars mfaRequired: true bzw. mfaEnrollmentRequired: true und ein kurzlebiges preAuthToken. Mit diesem Token (ebenfalls als Bearer) wird der zweite Faktor über POST /auth/2fa/verify bestätigt; erst danach gibt es das volle Token-Paar.

Headers

X-Customer-Id
string

Optionaler Kundenkontext. Ohne Header arbeitet die Anfrage im Standard-Kunden des angemeldeten Benutzers. Mit der ID eines anderen Kunden handelt die Anfrage in dessen Kontext: Listen, Lese- und Schreibzugriffe beziehen sich dann auf diesen Kunden.

Erlaubt sind der eigene Kunde, jeder Unterkunde im eigenen Teilbaum (Reseller handelt für seinen Endkunden) sowie Kunden, in denen der Benutzer selbst Mitglied ist. Übergeordnete oder fremde Kunden werden mit 403 Forbidden abgewiesen, eine unbekannte ID ebenfalls.

Die IDs der erreichbaren Kunden liefern GET /user/customers und GET /customers/{id}/children.

Example:

"01JD4Q8W3N6Y2K5T7R9V0B1C2D"

Path Parameters

id
string
required

Bill identifier

Response

Bill resource

Get a bill by id

id
string
name
string
Example:

"vServer #123"

billDay
integer

The day of the month when the quota is reset

Example:

"1"

allowed
string

The maximum speed of the traffic plan

Example:

"100Mbps"

used
string

The current used traffic of the traffic plan

Example:

"0bps"

type
enum<string>

The type of the billing

Available options:
CDR,
QUOTA
Example:

"CDR"

rateAverageMbit
string
Example:

"49.99 Mbit/s"

rate95thMbit
string
Example:

"49.99 Mbit/s"

usedInPercent
integer

The current used traffic of the traffic plan in percent

Example:

0