> ## 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 resource upgrade options

> The server's live size, the extras it already pays for, any unpaid upgrade, and this hardware's per-unit monthly prices
and ceilings. `pricing` is null when the hardware sells no upgrades. Prices are in the node group's `upgradeCurrency`
(converted to the service currency at order time). Session auth only; owner or team ADMIN.



## OpenAPI

````yaml /api-reference/openapi.yaml get /v1/cloud/{id}/upgrade
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/cloud/{id}/upgrade:
    get:
      tags:
        - Cloud
      summary: Get resource upgrade options
      description: >-
        The server's live size, the extras it already pays for, any unpaid
        upgrade, and this hardware's per-unit monthly prices

        and ceilings. `pricing` is null when the hardware sells no upgrades.
        Prices are in the node group's `upgradeCurrency`

        (converted to the service currency at order time). Session auth only;
        owner or team ADMIN.
      operationId: publicCloudGetUpgradeOptions
      parameters:
        - name: id
          in: path
          required: true
          description: Service id of the cloud server.
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: Upgrade options.
          content:
            application/json:
              schema:
                type: object
                required:
                  - success
                  - data
                properties:
                  success:
                    type: boolean
                    const: true
                  data:
                    type: object
                    required:
                      - server
                      - current
                      - currentPriceMinor
                      - pending
                      - pricing
                    properties:
                      server:
                        type: object
                        required:
                          - cores
                          - ramMb
                          - diskGb
                          - ipv4
                        description: Live size, already including paid extras.
                        properties:
                          cores:
                            type: integer
                          ramMb:
                            type: integer
                          diskGb:
                            type: integer
                          ipv4:
                            type: integer
                            description: Number of additional IPv4 addresses.
                      current:
                        $ref: '#/components/schemas/PublicCloudExtras'
                      currentPriceMinor:
                        type: integer
                        description: Monthly cost of the active extras, 0 when none.
                      pending:
                        type:
                          - object
                          - 'null'
                        required:
                          - invoiceId
                          - extras
                          - priceMinor
                        properties:
                          invoiceId:
                            type:
                              - string
                              - 'null'
                          extras:
                            $ref: '#/components/schemas/PublicCloudExtras'
                          priceMinor:
                            type: integer
                      pricing:
                        oneOf:
                          - type: 'null'
                          - $ref: '#/components/schemas/PublicCloudUpgradePricing'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '409':
          description: The server is still being built.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          $ref: '#/components/responses/ServerError'
      security:
        - bearerAuth: []
components:
  schemas:
    PublicCloudExtras:
      type: object
      description: >-
        Extra resources on top of the plan. Missing, negative or non-numeric
        values count as 0.
      properties:
        cores:
          type: integer
          minimum: 0
          default: 0
        ramGb:
          type: integer
          minimum: 0
          default: 0
        diskGb:
          type: integer
          minimum: 0
          default: 0
        ipv4:
          type: integer
          minimum: 0
          default: 0
    PublicCloudUpgradePricing:
      type: object
      required:
        - pricePerCore
        - pricePerGbRam
        - pricePerGbDisk
        - pricePerIpv4
        - maxExtraCores
        - maxExtraGbRam
        - maxExtraGbDisk
        - maxExtraIpv4
        - upgradeCurrency
        - hardware
      properties:
        pricePerCore:
          type:
            - integer
            - 'null'
          description: Monthly minor units; null when not sold.
        pricePerGbRam:
          type:
            - integer
            - 'null'
        pricePerGbDisk:
          type:
            - integer
            - 'null'
        pricePerIpv4:
          type:
            - integer
            - 'null'
        maxExtraCores:
          type: integer
        maxExtraGbRam:
          type: integer
        maxExtraGbDisk:
          type: integer
        maxExtraIpv4:
          type: integer
        upgradeCurrency:
          type: string
        hardware:
          type: string
          description: Node group name, or its tier when unnamed.
    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.