POST · Services
Hold a service upgrade for confirmation
Hold a service upgrade for confirmation
POST
/api/v1/services/{service}/actions/upgrade
Description
Validates the target type against the live upgrade options, then returns {status:"confirmation_required", confirmationUrl, …}. It charges nothing; on approval an unpaid proforma order is created and the plan changes only after it is paid.
Path parameters
| Name | Type | Description |
|---|---|---|
service
required
|
string |
Body
Send as application/json.
| Name | Type | Description |
|---|---|---|
input
required
|
string |
A domain, email address, website URL, or Inleed service id — for example example.se, [email protected] or 42976. Resolved to the owning account automatically, and the resolved target is echoed back in the response.
|
service_type_id
|
integer |
The target plan's service-type id. Get it from get_upgrade_options → options[].serviceTypeId.
Default 0
|
attempt_key
|
string | Idempotency key for this intent. Keep it stable across retries so a timed-out retry cannot buy the same thing twice. |
Responses
A 200 response returns the shape shown in the rail.
Every non-2xx response is an RFC 7807 problem with a stable
code.
Commonly returned errors
The codes this operation reaches on its own path: the auth stack, its own validation and
ownership checks, and the transport. Not a closed set — a shared code from the
full registry can still surface. Each links to the code’s own page,
the same URL its type dereferences to.
400
401
No token was presented, or the token is revoked, expired or unknown.
403
The token lacks a required scope, or this account does not own the resource.
404
No such resource for this account.
422
Validation error
429
The rate limit for this token is exhausted. See `Retry-After`.
500
Something went wrong on our side. The failure is logged against `requestId`.