compute
POST /v1/compute/servers/{serverId}/plan
Buy one paid option for this machine.
Authentication
Send an API key as a bearer token. The endpoint checks billing.payment.manage, sites.view; 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/compute/servers/{serverId}/plan \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "offer_id": <Uuid> }'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
⛔⛔ Chargeable twice over, and both are immediate. It debits Zinn®'s reseller balance at the provider and starts a recurring charge on the customer, so it sits behind billing.payment.manage rather than sites.create. The provider offers no idempotency header on this operation, so the request is keyed by (machine, option) on our side and a repeat returns the original purchase rather than buying a second one. 422 when the machine cannot carry the option — cPanel below 2 GB, a second cPanel licence, backups already on.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
serverId (path) | Uuid | Yes | The server's id, as listComputeServers reports it. Ours (UUIDv7), minted when the order row was written — never the provider's own identifier for the machine. |
Request body
| Name | Type | Required | What it is |
|---|---|---|---|
offer_id | Uuid | Yes | The offer to buy, from getComputeServerPlan's available or getVpsAddonOptions. ⛔ There is deliberately no price field: a price sent by a client is not read, and the charge… |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
data | ComputeAddonPurchase | Yes | One paid option a tenant actually bought against one machine. ⛔ status is cancelling, not ended, after a removal. The thing is still running and still ours to pay for until… |
Errors this endpoint can return
401 · 403 · 404 · 422 · 429 · 503