compute

DELETE /v1/panels/licences/{licenceId}

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

Alle compute Endpunkte

Authentifizierung

Senden Sie einen API-Schlüssel als Bearer-Token. Der Schlüssel muss über die Berechtigung billing.payment.manage verfügen; ein Schlüssel ohne diese wird mit 403 statt 404 abgelehnt.

Dieser Endpunkt erfordert keine Organisations-ID. Ihr Schlüssel identifiziert bereits die zugehörige Organisation, und die Antwort ist entsprechend eingeschränkt.

Ausprobieren

Ersetzen Sie alles in spitzen Klammern durch Ihre eigenen Werte und den Platzhalter für den Schlüssel durch einen Schlüssel aus Ihrem Dashboard.

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

Angemeldet? Die API-Konsole in Ihrem Dashboard trägt automatisch Ihre echte Organisations-ID sowie Ihren eigenen Schlüssel ein und führt die Anfrage gegen die Live-API aus, sodass Sie die tatsächliche Antwort sehen können. Öffnen Sie diesen Endpunkt in der API-Konsole

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

Parameter

NameTypErforderlichWas es ist
licenceId (path)UuidJaThe licence's id, as `listPanelLicences` reports it. Ours (UUIDv7).

Antwort

NameTypErforderlichWas es ist
idUuidJaUUIDv7 identifier — sortable by creation time (docs/02 §8).
product_codestringJaThe `PanelProduct.code` this licence is for.
statestring<pending, active, suspended, released, failed>Ja⛔ `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_kindstring<ours, customer>JaWhose 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_idUuidJaOur machine, when there is one. Null for a customer-owned server.
bound_ipstringJaThe 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_numberstringJaThe 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_minorintegerJaWhat 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…
currencystringJa
messagestringJaWhy it failed or was suspended, in a sentence the customer reads.
activated_atstringJa

Fehler, die dieser Endpunkt zurückgeben kann

401 · 403 · 404 · 429 · 503