billing
GET /v1/usage/visits
Get the organisation's metered visits and any overage charge.
ການພິສູດຕົວຕົນ
ສົ່ງລະຫັດ API ເປັນ bearer token. ລະຫັດຕ້ອງມີສິດ billing.view; ລະຫັດທີ່ບໍ່ມີສິດດັ່ງກ່າວຈະຖືກປະຕິເສດດ້ວຍລະຫັດ 403, ບໍ່ແມ່ນ 404.
ຈຸດເຊື່ອມຕໍ່ນີ້ບໍ່ໄດ້ຮັບ ID ອົງກອນ. ລະຫັດຂອງທ່ານໄດ້ລະບຸອົງກອນທີ່ມັນຂຶ້ນກັບແລ້ວ, ແລະ ຄໍາຕອບແມ່ນຖືກຈໍາກັດຂອບເຂດໄວ້ສໍາລັບອົງກອນນັ້ນ.
ລອງໃຊ້ເບິ່ງ
ປ່ຽນແທນທຸກຢ່າງທີ່ຢູ່ໃນວົງເລັບມຸມດ້ວຍຄ່າຂອງທ່ານເອງ, ແລະ ປ່ຽນແທນຕົວແທນບ່ອນວ່າງຄີດ້ວຍຄີຈາກແຜງຄວບຄຸມຂອງທ່ານ.
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