compute
DELETE /v1/panels/licences/{licenceId}
Release a licence — the only thing that stops the charge.
Authentication
Send an API key as a bearer token. The key must carry the billing.payment.manage permission; a key without it is refused with 403, not 404.
This endpoint takes no organisation id. Your key already identifies the organisation it belongs to, and the response is scoped to it.
Try it
Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.
curl -X DELETE https://api.zinndigital.com/v1/panels/licences/{licenceId} \
-H "Authorization: Bearer zdk_live_…"Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console
Details
⛔⛔ 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.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
licenceId (path) | Uuid | Yes | The licence's id, as listPanelLicences reports it. Ours (UUIDv7). |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
id | Uuid | Yes | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
product_code | string | Yes | The PanelProduct.code this licence is for. |
state | string<pending, active, suspended, released, failed> | Yes | ⛔ 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> | Yes | 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" are… |
server_id | Uuid | Yes | Our machine, when there is one. Null for a customer-owned server. |
bound_ip | string | Yes | 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 monthly… |
key_number | string | Yes | 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 | Yes | 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 | Yes | — |
message | string | Yes | Why it failed or was suspended, in a sentence the customer reads. |
activated_at | string | Yes | — |
Errors this endpoint can return
401 · 403 · 404 · 429 · 503