billing

GET /v1/billing/adhoc-charges

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

All billing endpoints

Authentication

Send an API key as a bearer token. The key must carry the billing.view permission; a key without it is refused with 403, not 404.

Where your organisation id goes

This endpoint takes org_id as a query parameter. Leave it out and the call covers your whole tenancy subtree; send it to narrow the call to one organisation.

Your organisation id is on the API keys screen in your dashboard, beside the key itself. It is the same id in every call you make.

Try it

Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.

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

Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console

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.

Parameters

NameTypeRequiredWhat it is
org_id (query)stringNoRequired 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.

Response

NameTypeRequiredWhat it is
dataAdhocCharge[]Yes
occurrencesAdhocChargeOccurrence[]Yes

Errors this endpoint can return

401 · 403 · 422 · 429