Authentication
Send an API key as a bearer token. The key must carry the billing.payment.manage permission; a key without it is refused with 403, not 404.
This endpoint takes no organisation id. Your key already identifies the organisation it belongs to, and the response is scoped to it.
Try it
Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.
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> }'Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console
Details
⛔ **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`.
Request body
| Name | Type | Required | What it is |
|---|---|---|---|
product_code | string | Yes | — |
currency | string | Yes | — |
target_kind | string<ours, customer> | No | — |
server_id | Uuid | No | Required when `target_kind` is `ours`. |
bound_ip | string | No | 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… |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
id | Uuid | Yes | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
product_code | string | Yes | The `PanelProduct.code` this licence is for. |
state | string<pending, active, suspended, released, failed> | Yes | ⛔ `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> | Yes | 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 | Yes | Our machine, when there is one. Null for a customer-owned server. |
bound_ip | string | Yes | 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 | Yes | 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 | Yes | 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 | Yes | — |
message | string | Yes | Why it failed or was suspended, in a sentence the customer reads. |
activated_at | string | Yes | — |
Errors this endpoint can return
401 · 403 · 422 · 429 · 503