billing
GET /v1/usage/visits
Get the organisation's metered visits and any overage charge.
身份验证
请将 API 密钥作为 bearer 令牌发送。该密钥必须具有 billing.view 权限；缺少该权限的密钥将被拒绝并返回 403 状态码，而非 404。
此端点不需要组织 ID。您的密钥已用于识别其所属的组织，且响应范围也仅限于该组织。
免费试用
将尖括号中的内容替换为您自己的值，并将键占位符替换为您仪表板中的一个键。
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