Monatsrechnung abrufen

Gibt die Abrechnungsdetails für einen ausgewählten Monat zurück.

Ruft die Abrechnungsdaten für den angeforderten Monat ab.

Prüfen Sie, ob für die Antwort ok === "BILL_FOUND" gilt, bevor Sie deren Abrechnungsfelder verwenden. Bei einer fehlenden Rechnung oder einer fehlgeschlagenen Abfrage wird error: "BILL_NOT_FOUND" mit HTTP 200 zurückgegeben. Der HTTP-Status allein belegt daher nicht, dass eine Rechnung gefunden wurde.

Der Pfadparameter billYearMonth hat das Format YYYY-MM. Um beispielsweise Ihre Rechnung für März 2019 abzurufen, verwenden Sie 2019-03.

Anfragebeispiel

Setzen Sie BILL_YEAR_MONTH auf Ihren Ressourcenwert, ohne ihn prozentzukodieren.

Gekündigte Workspaces können keine neuen Bearer-Token erstellen. Dieser Endpunkt bleibt mit einem vorhandenen aktiven Auth Key verfügbar: Verwenden Sie die Anleitung für signierte Abrechnungsanfragen anstelle der folgenden Token-Einrichtung. Der Auth Key muss die für diesen Endpunkt erforderlichen Scopes gewähren.

Führen Sie diese Anfrage in einer serverseitigen Shell mit curl und einem geeigneten Bearer-Token in TRANSLOADIT_TOKEN aus. Wenn Sie ein Token benötigen, klappen Sie die folgende Einrichtungsanleitung auf.

if ! TOKEN_RESPONSE="$(curl --fail-with-body -sS \
  --request POST \
  --url 'https://api2.transloadit.com/token' \
  --user "${TRANSLOADIT_KEY:?Set TRANSLOADIT_KEY}:${TRANSLOADIT_SECRET:?Set TRANSLOADIT_SECRET}" \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data-urlencode 'grant_type=client_credentials' \
  --data-urlencode 'aud=api2' \
  --data-urlencode 'scope=billing:read')"; then
  printf '%s\n' "$TOKEN_RESPONSE" >&2
  exit 1
fi
TRANSLOADIT_TOKEN="$(printf '%s' "$TOKEN_RESPONSE" |
  jq -er '.access_token | strings | select(length > 0)')" || exit 1

curl --fail-with-body -sS --request GET --get \
  --url "https://api2.transloadit.com/bill/${BILL_YEAR_MONTH:?Set BILL_YEAR_MONTH}" \
  --header "Authorization: Bearer ${TRANSLOADIT_TOKEN:?Set TRANSLOADIT_TOKEN}" \
  --data-urlencode 'params={}'

Dieser Endpunkt akzeptiert signierte params oder ein Bearer-Token. Anweisungen zur Einrichtung finden Sie unter Authentifizierung.

Erforderlicher Berechtigungsumfang für Auth Key oder Bearer-Token: billing:read.

Signierte Anfragen erfordern sowohl eine signature als auch einen in der Zukunft liegenden Zeitstempel für params.auth.expires. Bearer-Tokens erfordern keines von beiden.

Die Authentifizierungsfelder in dieser Liste gelten für signierte Anfragen. Mit einem Bearer-Token können Sie params.auth und das separate Feld signature weglassen. Vergleichen Sie unten die Anfrageparameter der einzelnen Authentifizierungsmethoden.

Zugriff auf Rechnungen nach der Kündigung

Gekündigte Workspaces können keine neuen Bearer-Token erstellen. Um ihre Rechnungen abzurufen, verwenden Sie eine signierte Anfrage mit einem vorhandenen aktiven Auth Key und dessen Auth Secret anstelle der oben beschriebenen Token-Einrichtung. Der Auth Key muss weiterhin den für diesen Endpunkt aufgeführten Scope gewähren.

Das Node.js-SDK signiert Rechnungsanfragen direkt; es ruft /token nicht auf. Installieren Sie es in einem vertrauenswürdigen serverseitigen Node.js-Projekt mit yarn add @transloadit/node. Legen Sie TRANSLOADIT_KEY, TRANSLOADIT_SECRET und BILL_YEAR_MONTH (zum Beispiel 2026-08) in der Umgebung fest. Bewahren Sie das Auth Secret in Ihrem Backend auf.

Dieses SDK-Beispiel verwendet sha384, den Standard für neu erstellte API-Schlüssel. Wenn Ihr Schlüssel einen anderen Signature-Algorithmus verwendet, folgen Sie stattdessen der Anleitung unter Signature Authentication und verwenden Sie dabei diesen konfigurierten Algorithmus.

Speichern Sie Folgendes als bill.mjs und führen Sie node bill.mjs aus:

import { Transloadit } from '@transloadit/node'

const { TRANSLOADIT_KEY, TRANSLOADIT_SECRET, BILL_YEAR_MONTH } = process.env
if (!TRANSLOADIT_KEY || !TRANSLOADIT_SECRET || !BILL_YEAR_MONTH) {
  throw new Error('Set TRANSLOADIT_KEY, TRANSLOADIT_SECRET, and BILL_YEAR_MONTH')
}

const transloadit = new Transloadit({
  authKey: TRANSLOADIT_KEY,
  authSecret: TRANSLOADIT_SECRET,
})
const bill = await transloadit.getBill(BILL_YEAR_MONTH)
if (bill.ok !== 'BILL_FOUND') throw new Error('No bill was returned')
console.log(JSON.stringify(bill, null, 2))

Die invoice_id ist für den aktuellen Monat null.