> ## Documentation Index
> Fetch the complete documentation index at: https://docs.server.express/llms.txt
> Use this file to discover all available pages before exploring further.

# Get a hosting subscription

> One subscription with its plan limits and, when the account is ACTIVE and Plesk answers, live disk and traffic usage.
Usage is best-effort: if Plesk is slow or down `usage` is null and the rest still loads. `provisionError` explains a
stuck order. Readable by the owner and any team member.



## OpenAPI

````yaml /api-reference/openapi.yaml get /v1/hosting/{id}
openapi: 3.1.0
info:
  title: Server.Express API
  version: 1.0.0
  description: >-
    The customer-facing Server.Express API: auth, billing, tickets, cloud and
    dedicated servers, hosting, reselling and account management. Every response
    uses the `{ success, data | error }` envelope.
  contact:
    name: Server.Express
    url: https://server.express
servers:
  - url: https://my.server.express/api
    description: Production
security:
  - bearerAuth: []
  - apiToken: []
tags:
  - name: API Tokens
  - name: Account
  - name: Auth
  - name: Cloud
  - name: Coupons
  - name: Credits
  - name: Dashboard
  - name: Dedicated
  - name: Health
  - name: Hosting
  - name: Integrations
  - name: Invoices
  - name: Livechat
  - name: Notifications
  - name: Passkeys
  - name: Payments
  - name: Products
  - name: Public
  - name: Public Invoices
  - name: Public Tools
  - name: Reseller
  - name: SSH Keys
  - name: Services
  - name: Tasks
  - name: Teams
  - name: Tickets
  - name: Web Hosting
  - name: Webhooks
paths:
  /v1/hosting/{id}:
    parameters:
      - name: id
        in: path
        required: true
        description: The hosting service id.
        schema:
          type: string
          format: uuid
    get:
      tags:
        - Hosting
      summary: Get a hosting subscription
      description: >-
        One subscription with its plan limits and, when the account is ACTIVE
        and Plesk answers, live disk and traffic usage.

        Usage is best-effort: if Plesk is slow or down `usage` is null and the
        rest still loads. `provisionError` explains a

        stuck order. Readable by the owner and any team member.
      operationId: publicDedicatedGetHosting
      responses:
        '200':
          description: The subscription.
          content:
            application/json:
              schema:
                type: object
                required:
                  - success
                  - data
                properties:
                  success:
                    type: boolean
                    const: true
                  data:
                    $ref: '#/components/schemas/PublicDedicatedHostingDetail'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/ServerError'
      security:
        - bearerAuth: []
        - apiToken: []
components:
  schemas:
    PublicDedicatedHostingDetail:
      type: object
      required:
        - id
        - label
        - billingStatus
        - nextDueDate
        - price
        - currency
        - billingCycle
        - createdAt
        - domain
        - status
        - username
        - location
        - plan
        - usage
        - provisionError
      properties:
        id:
          type: string
          format: uuid
        label:
          type: string
        billingStatus:
          $ref: '#/components/schemas/PublicDedicatedServiceStatus'
        nextDueDate:
          type:
            - string
            - 'null'
          format: date-time
        price:
          type:
            - integer
            - 'null'
        currency:
          type:
            - string
            - 'null'
        billingCycle:
          type:
            - string
            - 'null'
        createdAt:
          type: string
          format: date-time
        domain:
          type: string
        status:
          type: string
          description: Hosting account status; PENDING when not set up yet.
        username:
          type:
            - string
            - 'null'
        location:
          type:
            - string
            - 'null'
        plan:
          type:
            - object
            - 'null'
          required:
            - name
            - diskQuotaMb
            - trafficGb
            - domains
            - mailboxes
            - databases
          properties:
            name:
              type: string
            diskQuotaMb:
              type: integer
            trafficGb:
              type: integer
            domains:
              type: integer
            mailboxes:
              type: integer
            databases:
              type: integer
        usage:
          type:
            - object
            - 'null'
          required:
            - diskUsedBytes
            - trafficUsedBytes
          properties:
            diskUsedBytes:
              type:
                - integer
                - 'null'
            trafficUsedBytes:
              type:
                - integer
                - 'null'
        provisionError:
          type:
            - string
            - 'null'
    PublicDedicatedServiceStatus:
      type: string
      enum:
        - ACTIVE
        - SUSPENDED
        - TERMINATED
        - CANCELLED
        - PENDING
    ErrorResponse:
      type: object
      required:
        - success
        - error
      properties:
        success:
          type: boolean
          const: false
        error:
          type: string
          description: Human-readable error message.
      additionalProperties: true
  responses:
    Unauthorized:
      description: Missing, invalid or expired credentials.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    Forbidden:
      description: >-
        Authenticated but not allowed (missing scope, not an admin, or not your
        resource).
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    NotFound:
      description: The resource doesn't exist or isn't visible to you.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    ServerError:
      description: Unexpected server error.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        Session access token (JWT) from POST /v1/auth/login or /v1/auth/refresh.
        A session satisfies every API scope.
    apiToken:
      type: http
      scheme: bearer
      bearerFormat: se_live_<prefix>_<secret>
      description: >-
        Personal API token created under Settings → API tokens. Only routes
        guarded by verifyApiAuth accept it, and the token must carry the scope
        named in the operation's x-required-scope.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.