billing

GET `/v1/usage/visits`

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

Autentizace

Zašlete API klíč jako nosný token (bearer token). Klíč musí mít oprávnění billing.view; klíč bez něj je odmítnut s kódem 403, nikoli 404.

Tento koncový bod nevyžaduje žádné ID organizace. Váš klíč již identifikuje organizaci, ke které patří, a odpověď je na ni omezena.

Vyzvednout

Nahraďte cokoli v závorkách vlastními hodnotami a zástupný symbol klíče klíčem z vašeho řídicího panelu.

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

Přihlášeni? Konzole API ve vašem dashboardu automaticky doplní vaše skutečné ID organizace i váš vlastní klíč a odešle požadavek na živé API, abyste viděli reálnou odpověď. Otevřete tento koncový bod v konzoli API

Podrobnosti

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.

Odpověď

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

Chyby, které může tento koncový bod vrátit

401 · 403 · 404 · 429