compute

DELETE /v1/panels/licences/{licenceId}

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

Tous les points de terminaison compute

Authentification

Envoyez une clé API en tant que jeton du porteur. La clé doit posséder l'autorisation billing.payment.manage ; une clé qui ne l'a pas est refusée avec le code 403, et non 404.

Cet endpoint ne prend aucun identifiant d'organisation. Votre clé identifie déjà l'organisation à laquelle elle appartient, et la réponse y est limitée.

Essayer

Remplacez tout ce qui se trouve entre crochets par vos propres valeurs, et le espace réservé à la clé par une clé de votre tableau de bord.

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

Connecté ? La console d'API de votre tableau de bord saisit votre véritable ID d'organisation ainsi que votre propre clé, et exécute la requête sur l'API de production afin que vous puissiez voir la réponse réelle. Ouvrir ce point de terminaison dans la console API

Détails

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

Paramètres

NomTypeObligatoireQu'est-ce que c'est
licenceId (path)UuidOuiThe licence's id, as `listPanelLicences` reports it. Ours (UUIDv7).

Réponse

NomTypeObligatoireQu'est-ce que c'est
idUuidOuiUUIDv7 identifier — sortable by creation time (docs/02 §8).
product_codestringOuiThe `PanelProduct.code` this licence is for.
statestring<pending, active, suspended, released, failed>Oui⛔ `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>OuiWhose 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_idUuidOuiOur machine, when there is one. Null for a customer-owned server.
bound_ipstringOuiThe 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_numberstringOuiThe 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_minorintegerOuiWhat 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…
currencystringOui
messagestringOuiWhy it failed or was suspended, in a sentence the customer reads.
activated_atstringOui

Erreurs que cet point de terminaison peut renvoyer

401 · 403 · 404 · 429 · 503