billing

POST `/v1/sla/claims`

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

Autentifikimi

Drgoni një çelës API si një token mbajtës. Ky pikëndalim nuk specifikon një leje specifike në specifikim, prandaj jepini çelësit tuaj minimumin e nevojshëm dhe kontrolloni përgjigjen në vend që të supozoni.

Ku shkon id i organizatës suaj

Ky endpoint pranon org_id si parametër kërkimi. Lëreni bosh dhe thirrja do të mbulojë të gjithë nëndrurin tuaj të qiramarrjes; dërgojeni atë për ta ngushtuar thirrjen në një organizatë të vetme.

ID-ja e organizatës suaj ndodhet në ekranin e çelësave API në panelin tuaj të kontrollit, pranë vetë çelësit. Është i njëjti ID në çdo thirrje që bëni.

Provoje

Zëvendësoni çdo gjë brenda kllapave këndore me vlerat tuaja dhe vendbanuesin e çelësit me një çelës nga paneli juaj.

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> }'

Jeni kyçur? Konsola e API-së në panelin tuaj plotëson ID-në tuaj reale të organizatës dhe çelësin tuaj, dhe ekzekuton kërkesën kundrejt API-së live, kështu që ju mund të shihni përgjigjen aktuale. Hapni këtë pikë fundore në konsolën e API-së

Detajet

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`.

Parametrat

Emri	Lloji	Kërkohet	Çfarë është kjo
`org_id (query)`	`string`	Jo	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…

Trupi i kërkesës

Emri	Lloji	Kërkohet	Çfarë është kjo
`monitor_id`	`string`	Po	—
`period_start`	`string`	Po	Any instant in the calendar month being claimed; the month is derived from it.
`credit_percent`	`integer`	Jo	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…

Përgjigja

Emri	Lloji	Kërkohet	Çfarë është kjo
`id`	`string`	Po	—
`period_start`	`string`	Po	—
`credit_percent`	`integer`	Po	—
`amount_minor`	`integer`	Po	The credit in integer minor units of `currency` (§2.8 — money is never a float).
`currency`	`string`	Po	—
`outcome`	`string<measured, unadjudicable>`	Po	Whether the month adjudicated, or the credit was granted because our coverage could not decide it.
`uptime_percent`	`string`	Po	—
`created_at`	`string`	Po	—

Gabimet që ky pikëndalim mund të kthejë

401 · 403 · 404 · 409 · 422