billing
GET /v1/usage/visits
Get the organisation's metered visits and any overage charge.
ప్రమాణీకరణ
బీయర్ టోకెన్గా API కీని పంపండి. కీ తప్పనిసరిగా billing.view అనుమతిని కలిగి ఉండాలి; అది లేని కీని 404 కాకుండా 403తో తిరస్కరిస్తారు.
ఈ ఎండ్పాయింట్ ఎలాంటి సంస్థ ఐడీని తీసుకోదు. మీ కీ ఇప్పటికే అది ఏ సంస్థకు చెందుతుందో గుర్తిస్తుంది మరియు ప్రతిస్పందన దానికే పరిమితం చేయబడుతుంది.
ప్రయత్నించండి
కోణీయ బ్రాకెట్లలో ఉన్న దేన్నైనా మీ స్వంత విలువలతో భర్తీ చేయండి, మరియు కీ ప్లేస్హోల్డర్ను మీ డాష్బోర్డ్ నుండి తీసుకున్న కీతో భర్తీ చేయండి.
curl -X GET https://api.zinndigital.com/v1/usage/visits \
-H "Authorization: Bearer zdk_live_…"సైన్ ఇన్ చేశారా? మీ డ్యాష్బోర్డ్లోని API కాన్సోల్ మీ అసలైన సంస్థ ID మరియు మీ స్వంత కీని నింపుతుంది, అలాగే మీరు అసలైన ప్రతిస్పందనను చూడటానికి లైవ్ API ద్వారా ఆభ్యర్థనను రన్ చేస్తుంది. ఈ ఎండ్పాయింట్ను 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