GET `/v1/ai/site-agent/allowance`

How many self-serve site checks are left this month.

Ìfàṣẹ́pọ̀

Fi bọ́ọ̀lù (bearer token) ranṣẹ gẹ́gẹ́ bí kọ́kọ́rọ́ API. Kọ́kọ́rọ́ náà gbọ́dọ̀ ní ìyọ̀ǹda sites.view; a ó kọ̀ ọ́ silẹ pẹlu 403, kii ṣe 404, ti kọ́kọ́rọ́ náà kò bá ní i.

Ibùdó àmì ìdánimọ̀ ilé-iṣẹ́ rẹ sí

Oju-iwọle yii nlo org_id gẹgẹbi ayẹwo ibeere. Fi silẹ ni ita yoo si bo igi iyalo rẹ lapapọ; ranṣẹ si lati dín ibeere naa kù si ajọ kan.

Id àjọ rẹ wa lórí ojú-ìwákòòkò àwọn bọ́tìnnì API nínú daṣibọọdú rẹ, lẹ́gbẹ̀ẹ́ bọ́tìnnì náà gan-an. Ó jẹ́ ìd kan náà nínú gbogbo ìpè tí o bá ṣe.

Gbiyanju rẹ

Rọ́pọ̀ èyíkéyìí nínú àwọn àmì ìtọ́ka < > pẹ̀lú iye tirẹ̀, àti àmì ìdánimọ̀ bọ́tìnnì náà pẹ̀lú bọ́tìnnì kan láti inú dásibọ̀ọ̀dù rẹ.

curl -X GET https://api.zinndigital.com/v1/ai/site-agent/allowance \
  -H "Authorization: Bearer zdk_live_…"

Ṣé o ti wọlé? Iwọ̀n api ní nú ìgbékalẹ̀ rẹ kún id àjọ gidi rẹ ati bọtini tirẹ, o si nṣiṣẹ ibeere na lòdì si api gidi ki o le rii esi gidi na. Ṣí ojú abáná yìí sílẹ̀ nínú kọnsólù API

Àwọn kúlẹ̀kúlẹ̀

One allowance per organization per calendar month, sized by how many sites the organization has — not per site. Free grants from staff are added to it. Checks run from the **support ticket form are free and unmetered** and never appear in `used`: a customer who has exhausted their allowance can still open a ticket and still gets a full check on their site. `in_good_standing` is false while an account is suspended or unpaid, which pauses metered checks only — the ticket path and previously-purchased results are unaffected. Requires `sites.view`.

Àwọn ìpìlẹ̀

Orúkọ	Iru	Tí a nílò	Kini o jẹ
`org_id (query)`	`Uuid`	Bẹẹkọ	Which organization this is about. Required when the caller belongs to more than one; a caller in exactly one may omit it.

Idahun

Orúkọ	Iru	Tí a nílò	Kini o jẹ
`tier`	`string`	Bẹẹni	The tier this organization falls into.
`monthly`	`integer`	Bẹẹni	Checks from the tier
`granted`	`integer`	Bẹẹni	Extra checks granted by staff that have not expired.
`total`	`integer`	Bẹẹni	`monthly` + `granted`.
`used`	`integer`	Bẹẹni	Billable checks used this period. Ticket and staff checks are never counted.
`remaining`	`integer`	Bẹẹni	—
`exhausted`	`boolean`	Bẹẹni	The monthly allowance is spent. ⛔ This does NOT mean checks are refused — see `credit_checks`. Rendering "0 left" on this field alone tells a customer whose credit covers hundre…
`credit_checks`	`integer`	Bẹẹkọ	How many further checks the organization's Zinn® AI credit would cover once the allowance is gone. The allowance is the included tier of the one meter; beyond it a check is fu…
`exhausted_entirely`	`boolean`	Bẹẹkọ	Out of allowance AND out of credit — the only state in which a self-serve check is actually refused.
`in_good_standing`	`boolean`	Bẹẹni	False while the account is suspended or unpaid. Pauses metered checks only — the ticket path stays free and previously-purchased results stay readable.
`period_start`	`string`	Bẹẹni	—

Awọn aṣiṣe ti ibudo ipari yii le da pada

401 · 403 · 422 · 429