billing
GET /v1/usage/visits
Get the organisation's metered visits and any overage charge.
احراز هویت
یک کلید API را به عنوان یک توکن حامل ارسال کنید. این کلید باید دارای مجوز billing.view باشد؛ کلیدی که فاقد آن باشد با خطای 403 رد میشود، نه 404.
این نقطه پایانی هیچ شناسه سازمانی را دریافت نمیکند. کلید شما در حال حاضر سازمان مربوطه را مشخص میکند و پاسخ در همان محدوده ارائه میشود.
امتحان کنید
هر چیزی را که داخل براکتهای زاویهدار قرار دارد با مقادیر خودتان جایگزین کنید، و نگهدارنده کلید را با کلیدی از داشبورد خود جایگزین نمایید.
curl -X GET https://api.zinndigital.com/v1/usage/visits \
-H "Authorization: Bearer zdk_live_…"وارد شدهاید؟ کنسول API در داشبورد شما شناسه سازمان واقعی و کلید خودتان را پر میکند و درخواست را روی 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