billing
GET /v1/usage/visits
Get the organisation's metered visits and any overage charge.
인증
Bearer 토큰으로 API 키를 전송하세요. 키는 반드시 billing.view 권한을 가지고 있어야 하며, 권한이 없는 키는 404가 아닌 403으로 거부됩니다.
이 엔드포인트는 조직 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