billing

POST `/v1/sla/claims`

Claim the service credit for one monitored site's month.

Pagpapatotoo

Magpadala ng API key bilang bearer token. Ang endpoint na ito ay hindi naglatag ng tiyak na pahintulot sa pagtutukoy, kaya ibigay sa iyong key ang pinakamababang kailangan nito at suriin ang tugon sa halip na umasa.

Kung saan mapupunta ang id ng iyong organisasyon

Tinatanggap ng endpoint na ito ang org_id bilang parameter ng query. Huwag itong isama at saklaw ng tawag ang buong subtree ng iyong tenancy; ipadala ito para paliitin ang tawag sa isang organisasyon.

Ang id ng iyong organisasyon ay nasa screen ng mga API key sa iyong dashboard, sa tabi mismo ng key. Ito ang parehong id sa bawat tawag na gagawin mo.

Subukan ito

Palitan ang anuman sa loob ng mga panaklong na may anggulo ng iyong sariling mga halaga, at ang placeholder ng key na may key mula sa iyong dashboard.

curl -X POST https://api.zinndigital.com/v1/sla/claims \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "monitor_id": <string>, "period_start": <string> }'

Nakalagda? Ang API console sa iyong dashboard ay awtomatikong naglalagay ng iyong tunay na ID ng organisasyon at sariling susi, at pinapatakbo ang kahilingan laban sa live na API upang makita mo ang aktwal na tugon. Buksan ang endpoint na ito sa console ng API

Mga Detalye

Issues account credit — not cash — as a share of that site's monthly fee, and records it. **Idempotent by construction:** one month and one monitor may be credited exactly once, enforced by a unique constraint, so a retry, a race and a double click all lose the same way. `credit_percent` is read **only** when the month is `unadjudicable`; a measured month is credited at the tier its own figure reaches and a better one cannot be claimed. Gated on `sla.claim`.

Mga Parameter

Pangalan	Uri	Kailangan	Ano ito
`org_id (query)`	`string`	Hindi	Narrow to one organisation in the caller's subtree — what the dashboard's org switcher sends. ⛔ Narrow only: intersected with what the caller may already write to, so an org…

Katawan ng kahilingan

Pangalan	Uri	Kailangan	Ano ito
`monitor_id`	`string`	Oo	—
`period_start`	`string`	Oo	Any instant in the calendar month being claimed; the month is derived from it.
`credit_percent`	`integer`	Hindi	The published tier claimed. Read only when the month is `unadjudicable`, and refused unless it is one of `SlaPolicy.tiers[].credit_percent` — a tier is never rounded to the…

Tugon

Pangalan	Uri	Kailangan	Ano ito
`id`	`string`	Oo	—
`period_start`	`string`	Oo	—
`credit_percent`	`integer`	Oo	—
`amount_minor`	`integer`	Oo	The credit in integer minor units of `currency` (§2.8 — money is never a float).
`currency`	`string`	Oo	—
`outcome`	`string<measured, unadjudicable>`	Oo	Whether the month adjudicated, or the credit was granted because our coverage could not decide it.
`uptime_percent`	`string`	Oo	—
`created_at`	`string`	Oo	—

Mga error na maibabalik ng endpoint na ito

401 · 403 · 404 · 409 · 422