billing

GET /v1/billing/adhoc-charges

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

Все эндпоинты billing

Аутентификация

Отправьте ключ API в качестве токена носителя (bearer token). Ключ должен иметь разрешение billing.view; ключ без него отклоняется с кодом 403, а не 404.

Идентификатор вашей организации

Этот эндпоинт принимает org_id в качестве параметра запроса. Оставьте его пустым, и вызов охватит все поддерево вашей аренды; передайте его, чтобы сузить область вызова до одной организации.

Идентификатор вашей организации находится на экране ключей API в вашей панели управления, рядом с самим ключом. Это один и тот же идентификатор для каждого вашего запроса.

Попробовать

Замените всё в угловых скобках на собственные значения, а плейсхолдер ключа — на ключ из вашей панели управления.

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

Вошли в систему? Консоль API в вашей панели управления автоматически подставляет реальный идентификатор вашей организации и ваш собственный ключ, а также выполняет запрос к работающему API, чтобы вы могли увидеть актуальный ответ. Откройте эту конечную точку в API-консоли

Подробнее

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.

Параметры

ИмяТипОбязательноЧто это
org_id (query)stringНет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.

Ответ

ИмяТипОбязательноЧто это
dataAdhocCharge[]Да
occurrencesAdhocChargeOccurrence[]Да

Ошибки, которые может возвращать этот эндпоинт

401 · 403 · 422 · 429