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 POST https://api.zinndigital.com/v1/panels/licences \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "product_code": <string>, "currency": <string> }'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
⛔ **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`.
Corpo da requisição
| Nome | Tipo | Obrigatório | O que é |
|---|---|---|---|
product_code | string | Sim | — |
currency | string | Sim | — |
target_kind | string<ours, customer> | Não | — |
server_id | Uuid | Não | Required when `target_kind` is `ours`. |
bound_ip | string | Não | The 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 s… |
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 · 422 · 429 · 503