compute

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

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

Autenticação

Envie uma chave de API como um token de portador. A chave deve ter a permissão billing.payment.manage; uma chave sem ela é recusada com 403, e não 404.

Este endpoint não requer um ID de organização. Sua chave já identifica a organização à qual pertence, e a resposta é delimitada a ela.

Experimente

Substitua qualquer item entre colchetes por seus próprios valores e o espaço reservado para a chave por uma chave do seu painel.

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

Conectado? O console da API no seu painel preenche o ID da sua organização real e a sua própria chave, e executa a requisição contra a API de produção para que você possa ver a resposta real. Abra este endpoint no console da API

Detalhes

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

Parâmetros

Nome	Tipo	Obrigatório	O que é
`licenceId (path)`	`Uuid`	Sim	The licence's id, as `listPanelLicences` reports it. Ours (UUIDv7).

Resposta

Nome	Tipo	Obrigatório	O que é
`id`	`Uuid`	Sim	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`product_code`	`string`	Sim	The `PanelProduct.code` this licence is for.
`state`	`string<pending, active, suspended, released, failed>`	Sim	⛔ `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>`	Sim	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`	Sim	Our machine, when there is one. Null for a customer-owned server.
`bound_ip`	`string`	Sim	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`	Sim	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`	Sim	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`	Sim	—
`message`	`string`	Sim	Why it failed or was suspended, in a sentence the customer reads.
`activated_at`	`string`	Sim	—

Erros que este endpoint pode retornar

401 · 403 · 404 · 429 · 503

DELETE /v1/panels/licences/{licenceId}