billing

GET `/v1/billing/adhoc-charges`

The manual charges on your account, and what you have been billed.

Authentifizierung

Senden Sie einen API-Schlüssel als Bearer-Token. Der Schlüssel muss über die Berechtigung billing.view verfügen; ein Schlüssel ohne diese wird mit 403 statt 404 abgelehnt.

Hier kommt Ihre Organisations-ID hin

Dieser Endpunkt akzeptiert org_id als Abfrageparameter. Lassen Sie ihn weg, erfasst der Aufruf Ihren gesamten Mandanten-Unterbaum; übergeben Sie ihn, um den Aufruf auf eine Organisation einzugrenzen.

Die ID Ihrer Organisation finden Sie im Dashboard auf dem Bildschirm für API-Schlüssel direkt neben dem Schlüssel selbst. Sie ist bei jedem Ihrer Aufrufe dieselbe.

Ausprobieren

Ersetzen Sie alles in spitzen Klammern durch Ihre eigenen Werte und den Platzhalter für den Schlüssel durch einen Schlüssel aus Ihrem Dashboard.

curl -X GET https://api.zinndigital.com/v1/billing/adhoc-charges \
  -H "Authorization: Bearer zdk_live_…"

Angemeldet? Die API-Konsole in Ihrem Dashboard trägt automatisch Ihre echte Organisations-ID sowie Ihren eigenen Schlüssel ein und führt die Anfrage gegen die Live-API aus, sodass Sie die tatsächliche Antwort sehen können. Öffnen Sie diesen Endpunkt in der API-Konsole

Details

Ad-hoc items on your own account — anything a member of our team added by hand — plus the history of what has actually been billed. Requires `billing.view`. Two questions, two halves: `data` answers *"is this going to happen again"* and `occurrences` answers *"which invoice was that line on"*. The staff notes that sit beside these items are never returned here. `occurrences[].paid` is tri-state: `true`, `false`, or `null` when the order could not be read — "we do not know" and "you have not paid" are different things to say to somebody about their own money.

Parameter

Name	Typ	Erforderlich	Was es ist
`org_id (query)`	`string`	Nein	Required when you belong to more than one organisation. Omitted, it means your own — which is ambiguous for a reseller or an agency, so that answers 422 rather than guessing.

Antwort

Name	Typ	Erforderlich	Was es ist
`data`	`AdhocCharge[]`	Ja	—
`occurrences`	`AdhocChargeOccurrence[]`	Ja	—

Fehler, die dieser Endpunkt zurückgeben kann

401 · 403 · 422 · 429