compute

DELETE `/v1/panels/licences/{licenceId}`

Release a licence — the only thing that stops the charge.

احراز هویت

یک کلید API را به عنوان یک توکن حامل ارسال کنید. این کلید باید دارای مجوز billing.payment.manage باشد؛ کلیدی که فاقد آن باشد با خطای 403 رد می‌شود، نه 404.

این نقطه پایانی هیچ شناسه سازمانی را دریافت نمی‌کند. کلید شما در حال حاضر سازمان مربوطه را مشخص می‌کند و پاسخ در همان محدوده ارائه می‌شود.

امتحان کنید

هر چیزی را که داخل براکت‌های زاویه‌دار قرار دارد با مقادیر خودتان جایگزین کنید، و نگهدارنده کلید را با کلیدی از داشبورد خود جایگزین نمایید.

curl -X DELETE https://api.zinndigital.com/v1/panels/licences/{licenceId} \
  -H "Authorization: Bearer zdk_live_…"

وارد شده‌اید؟ کنسول API در داشبورد شما شناسه سازمان واقعی و کلید خودتان را پر می‌کند و درخواست را روی API زنده اجرا می‌کند تا بتوانید پاسخ واقعی را ببینید. این نقطه پایانی را در کنسول API باز کنید

جزئیات

⛔⛔ **Answers `503` and leaves the licence UNCHANGED if the supplier cannot be reached.** Reporting a release we did not achieve would remove the licence from every screen while the supplier kept billing for it — the orphan this product exists to prevent. Requires `billing.payment.manage`.

پارامترها

نام	نوع	الزامی	چیست
`licenceId (path)`	`Uuid`	بله	The licence's id, as `listPanelLicences` reports it. Ours (UUIDv7).

پاسخ

نام	نوع	الزامی	چیست
`id`	`Uuid`	بله	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`product_code`	`string`	بله	The `PanelProduct.code` this licence is for.
`state`	`string<pending, active, suspended, released, failed>`	بله	⛔ `suspended` is not a synonym for released. The charge has stopped and the record has not: the licence returns automatically when the account is back in good standing, with…
`target_kind`	`string<ours, customer>`	بله	Whose machine this licence runs on. ⛔ Stored rather than derived from whether `server_id` is set: "did we build this machine" and "whose problem is it when the disk fills" a…
`server_id`	`Uuid`	بله	Our machine, when there is one. Null for a customer-owned server.
`bound_ip`	`string`	بله	The address the licence is registered against at the supplier. ⛔ This is what releasing needs — by teardown the machine may be gone, and a licence we cannot release bills monthl…
`key_number`	`string`	بله	The panel-facing key number (`PLSK.01234567`) — an identifier, not a secret. ⛔ The activation code itself is never returned by this API; it lives in Vault.
`price_minor`	`integer`	بله	What the customer is charged per month, in minor units, frozen at purchase. A copy rather than a join, so an operator repricing the catalogue cannot move an existing customer's…
`currency`	`string`	بله	—
`message`	`string`	بله	Why it failed or was suspended, in a sentence the customer reads.
`activated_at`	`string`	بله	—

خطاهایی که این نقطه پایانی می‌تواند برگرداند

401 · 403 · 404 · 429 · 503

DELETE /v1/panels/licences/{licenceId}