compute

POST /v1/panels/licences

Buy a control-panel licence.

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 POST https://api.zinndigital.com/v1/panels/licences \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "product_code": <string>, "currency": <string> }'

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

This spends money at the supplier, monthly, until the licence is released. ⭐ On the customer's OWN machine the licence is bought immediately, because the address is known at order time. On one of ours it is recorded pending and bought the moment the machine has an IP — Openprovider Plesk licences are IP-bound, and one bought before an address exists is bound to nothing and cannot be released. ⛔ Answers 422 when the account is not in good standing, when the product is not on sale, when a licence for the customer's own server arrives without its IP, or when an extension is ordered for a machine holding no matching base edition. Answers 503 when the supplier could not be reached — in which case the licence is recorded and reconciled automatically rather than silently lost. Requires billing.payment.manage.

Treść żądania

NazwaTypWymaganeCo to jest
product_codestringTak
currencystringTak
target_kindstring<ours, customer>Nie
server_idUuidNieRequired when target_kind is ours.
bound_ipstringNieThe machine's IP. ⛔ Required when target_kind is customer and refused rather than defaulted: a licence registered against a guessed address is bound to somebody else's…

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 · 422 · 429 · 503