Abrechnung abrufen (get_billing)

Mit get_billing rufst du deine Hi-Walter-Abrechnungsdaten ab: deinen aktuellen Plan, den Abo-Status, dein verbleibendes Guthaben, Anfang und Ende des Abrechnungszeitraums sowie die Kosten in Credits für jedes verfügbare Tool.

Nutze diesen Endpunkt, um:

deine Ausgaben gegen deinen Plan zu überwachen,
dein nächstes Verlängerungsdatum zu bestätigen,
Live-Abrechnungsdaten direkt in deiner eigenen Anwendung anzuzeigen.

POST https://api.hiwalter.de/api/v1/tools/get_billing

Anfrage

Dieser Endpunkt erwartet keine Argumente. Sende ein leeres JSON-Objekt ({}).

Deinen API-Schlüssel übergibst du als Bearer-Token im Authorization-Header. Schlüssel haben das Format hw_XXXXXXXXXXX.

Header	Typ	Erforderlich	Beschreibung
`Authorization`	string	ja	Dein API-Schlüssel als Bearer-Token, z. B. `Bearer hw_XXXXXXXXXXX`.
`Content-Type`	string	ja	`application/json`

Beispiel (curl)

curl --request POST \
  --url https://api.hiwalter.de/api/v1/tools/get_billing \
  --header 'Authorization: Bearer hw_XXXXXXXXXXX' \
  --header 'Content-Type: application/json' \
  --data '{}'

Antwort

Bei Erfolg liefert der Endpunkt Status 200 und ein Objekt mit deinen Abrechnungsdaten.

{
  "results": {
    "plan": "subscription_997",
    "subscription_status": "active",
    "token_balance": -1,
    "unlimited": true,
    "current_period_start": "2026-07-09",
    "current_period_end": "2026-08-09",
    "token_costs": {
      "get_account": 1,
      "get_billing": 1,
      "get_usage": 1,
      "business_email_to_sha256": 1,
      "email_to_linkedin": 1,
      "email_to_maid": 1,
      "hem_to_email": 1,
      "hem_to_linkedin": 1,
      "reverse_email_lookup": 1,
      "ip_to_company": 1,
      "ip_to_hem": 1,
      "ip_to_maid": 1,
      "linkedin_to_all_personal_emails": 1,
      "linkedin_to_best_email": 1,
      "linkedin_to_best_personal_email": 1,
      "linkedin_to_business_email": 1,
      "linkedin_to_mobile_phone": 1,
      "linkedin_to_personal_email": 1,
      "linkedin_to_sha256": 1,
      "reverse_linkedin_lookup": 1,
      "search_business_email_by_name": 1,
      "search_business_profile_by_name": 1,
      "search_companies": 1,
      "search_linkedin_profile": 1,
      "search_people": 1
    }
  },
  "status": "ok",
  "metadata": {
    "fair_use": {
      "records_remaining_5h": 179999,
      "records_reset_5h": "2026-07-15T18:53:16Z",
      "records_remaining_1w": 899999,
      "records_reset_1w": "2026-07-22T13:53:16Z"
    }
  }
}

Feld	Typ	Beschreibung
`results.plan`	string	Kennung deines aktuellen Plans, z. B. `subscription_997` (997 € pro Zeitraum).
`results.subscription_status`	string	Status deines Abos, z. B. `active`.
`results.token_balance`	integer	Verbleibendes Guthaben in Credits. Bei einem unbegrenzten Plan steht hier `-1`.
`results.unlimited`	boolean	`true`, wenn dein Plan unbegrenztes Guthaben umfasst.
`results.current_period_start`	string	Startdatum des aktuellen Abrechnungszeitraums (`YYYY-MM-DD`).
`results.current_period_end`	string	Enddatum des aktuellen Abrechnungszeitraums bzw. dein nächstes Verlängerungsdatum (`YYYY-MM-DD`).
`results.token_costs`	object	Zuordnung von Tool-Name zu den Kosten in Credits pro Aufruf.
`status`	string	Gesamtstatus der Antwort, z. B. `ok`.
`metadata.fair_use`	object	Fair-Use-Kontingente: verbleibende Datensätze und Reset-Zeitpunkte für das 5-Stunden- und das 1-Wochen-Fenster.