Get shared-hosting account

Return one shared-hosting account with domains, billing, resource limits, control-panel metadata, billing-cycle options, and lifecycle action gates.

Web Hosting Hosting Accounts

Authentication

Required API scope: read:hosting

Use Authorization: Bearer <token> for API keys. Dashboard sessions may also use hostup_session.

Context

Path Parameters

accountId string required Example: acct_01hxa3b4c5d6e7f8g9h0j1k2m3

Public shared-hosting account ID. Get it from GET /api/v2/shared-hosting `data[].id`. Do not invent this value; use the exact ID returned by the referenced API response.

Headers

Accept Example
Content-Type Example

Responses

200 Shared-hosting account.
id string · Example: acct_01hxa3b4c5d6e7f8g9h0j1k2m3
name string · Example: example.com

Customer-facing account name. Defaults to the primary domain when no custom name is set.

primaryDomain stringnull · Example: example.com
domains array<string> · Example: ["example.com"]

Domains known on this account. List responses normally include the primary domain only.

customName stringnull · Example: null
serviceStatus string · enum · Example: active
active
pending
suspended
cancelled
terminated
expired
fraud
unknown
billing object
billing.amount number required · Example: 99
billing.currencyCode string required · Example: SEK
billing.billingCycle stringnull · enum required · Example: annually
monthly
quarterly
semiannually
annually
biennially
triennially
free
createdAt stringnull · Example: 2026-04-27T12:34:56.000Z
nextDueAt stringnull · Example: 2026-05-27T12:00:00.000Z
expiresAt stringnull · Example: null
pinned boolean · Example: false
resources objectnull
controlPanel object
controlPanel.type string · enum required · Example: cpanel
cpanel
controlPanel.supportsWhm boolean · Example: true

Only present when the account supports WHM access.

billingCycleState object | null
billingCycleState.billingCycleOptions array<object> required
billingCycleState.billingCycleOptions[].billingCycle string · enum required · Example: annually
monthly
quarterly
semiannually
annually
biennially
triennially
free
billingCycleState.billingCycleOptions[].amount number required · Example: 1188
billingCycleState.billingCycleOptions[].initialAmount number · Example: 149

Present only when the first payment differs from the recurring amount.

billingCycleState.billingCycleOptions[].currencyCode string required · Example: SEK
billingCycleState.billingCycleOptions[].isCurrent boolean required · Example: true
billingCycleState.billingCycleOptions[].savingsPercent numbernull required · Example: null
billingCycleState.actions object required
billingCycleState.actions.canSwitchCycle object required
billingCycleState.actions.canSwitchCycle.allowed boolean required · Example: true
billingCycleState.actions.canSwitchCycle.reason stringnull required · Example: null
billingCycleState.actions.canSwitchCycle.code stringnull · Example: pending_order

Machine-readable reason code when an action is blocked.

actions object | null

Null on list responses. Detail responses include lifecycle and control-panel action gates.

actions.canRenew object required
actions.canRenew.allowed boolean required · Example: true
actions.canRenew.reason stringnull required · Example: null
actions.canRenew.code stringnull · Example: pending_order

Machine-readable reason code when an action is blocked.

actions.canChangeBillingCycle object required
actions.canChangeBillingCycle.allowed boolean required · Example: true
actions.canChangeBillingCycle.reason stringnull required · Example: null
actions.canChangeBillingCycle.code stringnull · Example: pending_order

Machine-readable reason code when an action is blocked.

actions.canPause object required
actions.canPause.allowed boolean required · Example: true
actions.canPause.reason stringnull required · Example: null
actions.canPause.code stringnull · Example: pending_order

Machine-readable reason code when an action is blocked.

actions.canUpgrade object required
actions.canUpgrade.allowed boolean required · Example: true
actions.canUpgrade.reason stringnull required · Example: null
actions.canUpgrade.code stringnull · Example: pending_order

Machine-readable reason code when an action is blocked.

actions.canCancel object required
actions.canCancel.allowed boolean required · Example: true
actions.canCancel.reason stringnull required · Example: null
actions.canCancel.code stringnull · Example: pending_order

Machine-readable reason code when an action is blocked.

actions.canAddStorage object required
actions.canAddStorage.allowed boolean required · Example: true
actions.canAddStorage.reason stringnull required · Example: null
actions.canAddStorage.code stringnull · Example: pending_order

Machine-readable reason code when an action is blocked.

actions.canSso object required
actions.canSso.allowed boolean required · Example: true
actions.canSso.reason stringnull required · Example: null
actions.canSso.code stringnull · Example: pending_order

Machine-readable reason code when an action is blocked.

tags array<string>
400 Invalid request. The response body is an RFC 7807 Problem Details document.
type string · Example: https://developer.hostup.se/errors/invalid_request
title string · Example: Validation failed
status integer · Example: 400
detail string · Example: The request body failed validation.
code string · Example: invalid_request

Stable machine-readable code. Branch on this field, not on `detail`.

instance string · Example: /api/v2/orders
requestId string · Example: req_01hxa3b4c5d6e7f8g9h0j1k2m3
timestamp string · Example: 2026-04-27T12:34:56.000Z
errors array<object>

Field-level validation errors when `code` is `invalid_request`.

errors[].pointer string required · Example: /items/0/eppCode
errors[].detail string required · Example: `eppCode` is required for this transfer.
errors[].code string required · Example: missing_required
extensions object
401 Unauthorized. Authentication is required.
type string · Example: https://developer.hostup.se/errors/invalid_request
title string · Example: Validation failed
status integer · Example: 400
detail string · Example: The request body failed validation.
code string · Example: invalid_request

Stable machine-readable code. Branch on this field, not on `detail`.

instance string · Example: /api/v2/orders
requestId string · Example: req_01hxa3b4c5d6e7f8g9h0j1k2m3
timestamp string · Example: 2026-04-27T12:34:56.000Z
errors array<object>

Field-level validation errors when `code` is `invalid_request`.

errors[].pointer string required · Example: /items/0/eppCode
errors[].detail string required · Example: `eppCode` is required for this transfer.
errors[].code string required · Example: missing_required
extensions object
403 Forbidden. The caller lacks a required scope or does not own the resource.
type string · Example: https://developer.hostup.se/errors/invalid_request
title string · Example: Validation failed
status integer · Example: 400
detail string · Example: The request body failed validation.
code string · Example: invalid_request

Stable machine-readable code. Branch on this field, not on `detail`.

instance string · Example: /api/v2/orders
requestId string · Example: req_01hxa3b4c5d6e7f8g9h0j1k2m3
timestamp string · Example: 2026-04-27T12:34:56.000Z
errors array<object>

Field-level validation errors when `code` is `invalid_request`.

errors[].pointer string required · Example: /items/0/eppCode
errors[].detail string required · Example: `eppCode` is required for this transfer.
errors[].code string required · Example: missing_required
extensions object
404 Not found. The resource does not exist or is not owned by the caller.
type string · Example: https://developer.hostup.se/errors/invalid_request
title string · Example: Validation failed
status integer · Example: 400
detail string · Example: The request body failed validation.
code string · Example: invalid_request

Stable machine-readable code. Branch on this field, not on `detail`.

instance string · Example: /api/v2/orders
requestId string · Example: req_01hxa3b4c5d6e7f8g9h0j1k2m3
timestamp string · Example: 2026-04-27T12:34:56.000Z
errors array<object>

Field-level validation errors when `code` is `invalid_request`.

errors[].pointer string required · Example: /items/0/eppCode
errors[].detail string required · Example: `eppCode` is required for this transfer.
errors[].code string required · Example: missing_required
extensions object
429 Rate limited. Retry after the limit resets. 429 responses include `Retry-After` seconds plus `X-RateLimit-*` headers.
type string · Example: https://developer.hostup.se/errors/invalid_request
title string · Example: Validation failed
status integer · Example: 400
detail string · Example: The request body failed validation.
code string · Example: invalid_request

Stable machine-readable code. Branch on this field, not on `detail`.

instance string · Example: /api/v2/orders
requestId string · Example: req_01hxa3b4c5d6e7f8g9h0j1k2m3
timestamp string · Example: 2026-04-27T12:34:56.000Z
errors array<object>

Field-level validation errors when `code` is `invalid_request`.

errors[].pointer string required · Example: /items/0/eppCode
errors[].detail string required · Example: `eppCode` is required for this transfer.
errors[].code string required · Example: missing_required
extensions object
500 Internal error. Retry later or contact support if the issue persists.
type string · Example: https://developer.hostup.se/errors/invalid_request
title string · Example: Validation failed
status integer · Example: 400
detail string · Example: The request body failed validation.
code string · Example: invalid_request

Stable machine-readable code. Branch on this field, not on `detail`.

instance string · Example: /api/v2/orders
requestId string · Example: req_01hxa3b4c5d6e7f8g9h0j1k2m3
timestamp string · Example: 2026-04-27T12:34:56.000Z
errors array<object>

Field-level validation errors when `code` is `invalid_request`.

errors[].pointer string required · Example: /items/0/eppCode
errors[].detail string required · Example: `eppCode` is required for this transfer.
errors[].code string required · Example: missing_required
extensions object
GET https://cloud.hostup.se/api/v2/shared-hosting/{accountId}
For AI assistants
View as Markdown
cURL 
curl -X GET "https://cloud.hostup.se/api/v2/shared-hosting/acct_01hxa3b4c5d6e7f8g9h0j1k2m3" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"
Response 
{
  "id": "acct_01hxa3b4c5d6e7f8g9h0j1k2m3",
  "name": "example.com",
  "primaryDomain": "example.com",
  "domains": [
    "example.com"
  ],
  "customName": null,
  "serviceStatus": "active",
  "billing": {
    "amount": 1188,
    "currencyCode": "SEK",
    "billingCycle": "annually"
  },
  "createdAt": null,
  "nextDueAt": "2026-05-27T12:00:00.000Z",
  "expiresAt": null,
  "pinned": false,
  "resources": null,
  "controlPanel": {
    "type": "cpanel"
  },
  "billingCycleState": {
    "billingCycleOptions": [
      {
        "billingCycle": "monthly",
        "amount": 149,
        "currencyCode": "SEK",
        "isCurrent": false,
        "savingsPercent": null
      },
      {
        "billingCycle": "annually",
        "amount": 1188,
        "currencyCode": "SEK",
        "isCurrent": true,
        "savingsPercent": null
      }
    ],
    "actions": {
      "canSwitchCycle": {
        "allowed": true,
        "reason": null
      }
    }
  },
  "actions": {
    "canRenew": {
      "allowed": true,
      "reason": null
    },
    "canChangeBillingCycle": {
      "allowed": true,
      "reason": null
    },
    "canPause": {
      "allowed": true,
      "reason": null
    },
    "canUpgrade": {
      "allowed": true,
      "reason": null
    },
    "canCancel": {
      "allowed": true,
      "reason": null
    },
    "canAddStorage": {
      "allowed": true,
      "reason": null
    },
    "canSso": {
      "allowed": true,
      "reason": null
    }
  },
  "tags": []
}