billing

GET `/v1/usage/visits`

Get the organisation's metered visits and any overage charge.

Doğrulama

API açarını bearer token kimi göndərin. Açar billing.view icazəsinə malik olmalıdır; bu icazəsi olmayan açar 404 deyil, 403 xətası ilə rədd edilir.

Bu endpoint heç bir təşkilat ID-si tələb etmir. Sizin açarınız artıq aid olduğu təşkilatı müəyyən edir və cavab həmin təşkilat üçün məhdudlaşdırılır.

Sınaqdan keçir

Bucaqlı mötərizələrdə olan hór şeyi öz qiymətlərinizlə, açar yertutucusunu isə idarə panelinizdən bir açarla əvəz edin.

curl -X GET https://api.zinndigital.com/v1/usage/visits \
  -H "Authorization: Bearer zdk_live_…"

Sistemə daxil olmusunuz? İdarə panelinizdəki API konsolu real təşkilatınızın identifikatorunu və öz açarınızı avtomatik doldurur, sorğunu canlı API-yə qarşı icra edir ki, siz faktiki cavabı görə biləsiniz. Bu son nöqtəni API konsolunda açın

Təfərrüatlar

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.

Cavab

Ad	Tip	Tələb olunur	Nədir
`period_start`	`string`	Bəli	Start of the subscription's current billing period.
`period_end`	`string`	Bəli	End of the subscription's current billing period.
`page_views`	`integer`	Bəli	Billable human page views this period, across every site the plan pays for.
`excluded_page_views`	`integer`	Bəli	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əli	The ceiling applied to this period, already pro-rated where `prorated` is true. `-1` means unlimited.
`full_allowance`	`integer`	Bəli	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əli	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əli	Whether the plan grants unlimited visits.
`remaining`	`integer`	Bəli	Page views left in the allowance. Never negative.
`over_by`	`integer`	Bəli	Page views beyond the allowance. Never negative.
`over_limit`	`boolean`	Bəli	Whether the allowance has been exceeded. The site keeps serving either way.
`overage_blocks`	`integer`	Bəli	Blocks of overage, rounded up — one page view over the allowance buys a whole block.
`overage_amount_minor`	`integer`	Bəli	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əli	ISO 4217 code for `overage_amount_minor`. Null exactly when it is.

Bu son nöqtənin qaytara biləcəyi xətalar

401 · 403 · 404 · 429