PUT `/v1/ai/credits/settings`

Turn automatic top-up on or off.

المصادقة

أرسل مفتاح واجهة برمجة التطبيقات (API key) كرمز حامل (bearer token). يجب أن يحمل المفتاح إذن billing.payment.manage؛ والمفتاح الذي لا يملكه يُرفض بالرمز 403 وليس 404.

لا يقبل هذا الطرف أي معرف للمؤسسة. يحدد مفتاحك بالفعل المؤسسة التي ينتمي إليها، وتكون الاستجابة محصورة في نطاقها.

جربه الآن

استبدل أي شيء بين أقواس زاوية بقيمك الخاصة، والعنصر النائب للمفتاح بمفتاح من لوحة تحكمك.

curl -X PUT https://api.zinndigital.com/v1/ai/credits/settings \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "auto_topup_enabled": <boolean> }'

هل سجلت الدخول؟ تقوم وحدة تحكم واجهة برمجة التطبيقات في لوحة التحكم الخاصة بك بربط معرف مؤسستك الحقيقي ومفتاحك الخاص، وتنفذ الطلب مقابل واجهة برمجة التطبيقات المباشرة لتتمكن من رؤية الاستجابة الفعلية. افتح هذه النهاية الطرفية في وحدة تحكم API

التفاصيل

Automatic top-up is **off by default** and only the customer can turn it on. When it is on, running below the threshold buys the chosen pack once, with an hour between attempts so a declining card cannot be retried in a loop. Requires `billing.payment.manage` — turning this on is a decision to let us charge a saved card, which is the same audience as managing a provider key.

جسم الطلب

الاسم	النوع	مطلوب	ما هو هذا
`auto_topup_enabled`	`boolean`	نعم	—
`auto_topup_pack_code`	`string`	لا	—
`auto_topup_threshold_micros`	`integer`	لا	`0` keeps the shared low-balance threshold. Any other value below `min_threshold_micros` is a `422` — but only when `auto_topup_enabled` is true: refusing to let somebody sw…
`auto_topup_monthly_cap_micros`	`integer`	لا	`0` uses the computed default. A ceiling smaller than one top-up is a `422`: it is not a strict setting, it is an off switch wearing one — every attempt would exceed it and noth…

الاستجابة

الاسم	النوع	مطلوب	ما هو هذا
`state`	`AiCreditState`	نعم	—
`packs`	`AiCreditPack[]`	نعم	—
`settings`	`AiCreditSettings`	نعم	The customer's standing instruction about topping up, and what has become of it. Owner, 2026-08-24, reading `/ai` on production: *"The auto top section doesnt allow you to selec…
`history`	`AiCreditHistoryLine[]`	نعم	The 25 most recent movements, newest first.
`funding_routes`	`AiProviderFunding[]`	نعم	Who pays for the next call, per provider. Read on the SAME request as the balance, so a screen cannot render a funding claim from one moment beside a balance from another.
`spends`	`AiCreditSpend[]`	نعم	Everything this credit buys — the metered surfaces derived from the engine's own meter, the credit-only spends that write no usage row, and the fixed-price AI products.

الأخطاء التي يمكن أن تُرجعها نقطة النهاية هذه

401 · 403 · 422 · 429

PUT /v1/ai/credits/settings