billing
GET /v1/usage/visits
Get the organisation's metered visits and any overage charge.
Ìfàṣẹ́pọ̀
Fi bọ́ọ̀lù (bearer token) ranṣẹ gẹ́gẹ́ bí kọ́kọ́rọ́ API. Kọ́kọ́rọ́ náà gbọ́dọ̀ ní ìyọ̀ǹda billing.view; a ó kọ̀ ọ́ silẹ pẹlu 403, kii ṣe 404, ti kọ́kọ́rọ́ náà kò bá ní i.
Ojú abánisọ̀rọ̀ yìí kò gba id ajọ kankan. Kọ́kọ́rọ́ rẹ ti mọ ajọ ti o jẹ ti e, a o si fèsì nipa rẹ̀.
Gbiyanju rẹ
Rọ́pọ̀ èyíkéyìí nínú àwọn àmì ìtọ́ka < > pẹ̀lú iye tirẹ̀, àti àmì ìdánimọ̀ bọ́tìnnì náà pẹ̀lú bọ́tìnnì kan láti inú dásibọ̀ọ̀dù rẹ.
curl -X GET https://api.zinndigital.com/v1/usage/visits \
-H "Authorization: Bearer zdk_live_…"Ṣé o ti wọlé? Iwọ̀n api ní nú ìgbékalẹ̀ rẹ kún id àjọ gidi rẹ ati bọtini tirẹ, o si nṣiṣẹ ibeere na lòdì si api gidi ki o le rii esi gidi na. Ṣí ojú abáná yìí sílẹ̀ nínú kọnsólù API
Àwọn kúlẹ̀kúlẹ̀
Billable page views for the current billing period against the plan's monthly_visits allowance, plus the overage that has accrued. Requires billing.view rather than sites.view: this endpoint's distinguishing content is a charge, and a teammate granted site access to publish content should not thereby learn what the account is about to be invoiced. Over the allowance, the site keeps serving (owner ruling 2026-08-11). Nothing is throttled, suspended or refused for being popular; the excess is billed per block of 10,000 page views and shown here before the invoice is raised. The first partial period is pro-rated. Metering began on 2026-08-11 and nothing before it can be measured, so a period that started earlier has its allowance scaled to the part actually observed and prorated is true — otherwise a customer would be billed for a gap in our own instrumentation. fullAllowance carries the unscaled monthly figure so the UI can show both. overageAmountMinor and overageCurrency are null together when no overage rate is in force. That is a real state and it is not zero: "not yet priced" and "costs nothing" are different facts, and only one of them is safe to show a customer as a bill.
Idahun
| Orúkọ | Iru | Tí a nílò | Kini o jẹ |
|---|---|---|---|
period_start | string | Bẹẹni | Start of the subscription's current billing period. |
period_end | string | Bẹẹni | End of the subscription's current billing period. |
page_views | integer | Bẹẹni | Billable human page views this period, across every site the plan pays for. |
excluded_page_views | integer | Bẹẹni | Page views excluded as automated. Published so the bot rule is auditable — a customer disputing an invoice can see what they were not charged for. |
allowance | integer | Bẹẹni | The ceiling applied to this period, already pro-rated where prorated is true. -1 means unlimited. |
full_allowance | integer | Bẹẹni | The plan's unscaled monthly monthly_visits grant, so the UI can quote the pricing-page figure alongside a pro-rated one. |
prorated | boolean | Bẹẹni | Whether allowance was scaled down because this period began before metering did. Surfaced so a number that will not match the pricing page can be explained rather than looking… |
unlimited | boolean | Bẹẹni | Whether the plan grants unlimited visits. |
remaining | integer | Bẹẹni | Page views left in the allowance. Never negative. |
over_by | integer | Bẹẹni | Page views beyond the allowance. Never negative. |
over_limit | boolean | Bẹẹni | Whether the allowance has been exceeded. The site keeps serving either way. |
overage_blocks | integer | Bẹẹni | Blocks of overage, rounded up — one page view over the allowance buys a whole block. |
overage_amount_minor | integer | Bẹẹni | The overage charge in minor units of overage_currency (integer minor units, never a float). null when no overage rate is in force, which is not the same as zero. |
overage_currency | string | Bẹẹni | ISO 4217 code for overage_amount_minor. Null exactly when it is. |
Awọn aṣiṣe ti ibudo ipari yii le da pada
401 · 403 · 404 · 429