billing

GET `/v1/usage/visits`

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

تصدیق‌هویت

یو API کی د بیئرر ټوکن (bearer token) په توګه ولیکئ. کی باید د billing.view اجازه ولري؛ له دې اجازې پرته کی د 404 پرځای د 403 په واسطه رد کیږي.

دا پای نقطه د سازمان هېڅ آی ډي نه اخلي. ستاسو کیلي مخکې تر مخکې هغه سازمان په ګوته کوي چې پورې اړه لري، او ځواب ورته محدود دی.

هڅه وکړئ

د انګلیسي په زاوي پنسونو کې هرڅه د خپلو ارزښتونو سره بدل کړئ، او د کلي ځای لرونکی ستاسو د ډشبورډ د کلي سره.

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

ننوتي یاست؟ ستاسو په ډشبورډ کې د API کنسول ستاسو د اصلي سازمان ID او ستاسو خپله کیلي ډکوي، او غوښتنه د ژوندی API په وړاندې پرمخ وړي ترڅو تاسو وکولی شئ اصلي ځواب وګورئ. دا پای ټکی (endpoint) د API په کنسول کې پرانیزئ

تفصیلات

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.

ځواب

نوم	ډول	اړین	دا څه شی دی
`period_start`	`string`	هو	Start of the subscription's current billing period.
`period_end`	`string`	هو	End of the subscription's current billing period.
`page_views`	`integer`	هو	Billable human page views this period, across every site the plan pays for.
`excluded_page_views`	`integer`	هو	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`	هو	The ceiling applied to this period, already pro-rated where `prorated` is true. `-1` means unlimited.
`full_allowance`	`integer`	هو	The plan's unscaled monthly `monthly_visits` grant, so the UI can quote the pricing-page figure alongside a pro-rated one.
`prorated`	`boolean`	هو	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`	هو	Whether the plan grants unlimited visits.
`remaining`	`integer`	هو	Page views left in the allowance. Never negative.
`over_by`	`integer`	هو	Page views beyond the allowance. Never negative.
`over_limit`	`boolean`	هو	Whether the allowance has been exceeded. The site keeps serving either way.
`overage_blocks`	`integer`	هو	Blocks of overage, rounded up — one page view over the allowance buys a whole block.
`overage_amount_minor`	`integer`	هو	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`	هو	ISO 4217 code for `overage_amount_minor`. Null exactly when it is.

تېروتنې چې دا پای ټکی یې بیرته راګرځولی شي

401 · 403 · 404 · 429