compute

DELETE /v1/panels/licences/{licenceId}

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

Wszystkie punkty końcowe compute

Wszystkie dokumentacje dla programistów

Uwierzytelnianie

Wyślij klucz API jako token bearer. Klucz musi posiadać uprawnienie billing.payment.manage; klucz bez niego jest odrzucany z kodem 403, a nie 404.

Ten punkt końcowy nie wymaga identyfikatora organizacji. Twój klucz już identyfikuje organizację, do której należy, a odpowiedź jest do niej ograniczona.

Wypróbuj

Zastąp wszystko w nawiasach ostrych własnymi wartościami, a zastępczy znacznik klucza kluczem ze swojego pulpitu nawigacyjnego.

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

Zalogowany? Konsola API w Twoim panelu uzupełnia rzeczywiste identyfikator organizacji oraz Twój własny klucz i wykonuje żądanie względem aktywnego API, dzięki czemu możesz zobaczyć rzeczywistą odpowiedź. Otwórz ten punkt końcowy w konsoli API

Szczegóły

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

Parametry

NazwaTypWymaganeCo to jest
licenceId (path)UuidTakThe licence's id, as listPanelLicences reports it. Ours (UUIDv7).

Odpowiedź

NazwaTypWymaganeCo to jest
idUuidTakUUIDv7 identifier — sortable by creation time (docs/02 §8).
product_codestringTakThe PanelProduct.code this licence is for.
statestring<pending, active, suspended, released, failed>Taksuspended 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>TakWhose 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_idUuidTakOur machine, when there is one. Null for a customer-owned server.
bound_ipstringTakThe 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_numberstringTakThe 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_minorintegerTakWhat 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…
currencystringTak
messagestringTakWhy it failed or was suspended, in a sentence the customer reads.
activated_atstringTak

Błędy, które ten punkt końcowy może zwrócić

401 · 403 · 404 · 429 · 503