> ## 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.

# Change plan

> Moves the server to another plan on the same hardware. Upgrades with something to pay raise an UNPAID invoice (due in
7 days) for the prorated difference and land when it's paid — `applied: false`. Downgrades, sideways moves and zero-cost
upgrades apply immediately and pay unused value back as extra days on the renewal date — `applied: true`. When the
target plan's disk is smaller you must send `diskStrategy`: `keep` carries the extra disk as a paid customisation,
`reinstall` rebuilds at the smaller size and loses the data. Session auth only; owner or team ADMIN.
409 when it's the current plan, another change or upgrade is unpaid, a disk decision is needed (`data.needsDiskDecision`
and `data.disk` are returned), or extra disk can't be sold on this hardware. 503 if the plan can't be priced in the
service currency. Writes an `ORDER_CLOUD_PLAN_CHANGE` audit entry when an invoice is raised.



## OpenAPI

````yaml /api-reference/openapi.yaml post /v1/cloud/{id}/plan
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}/plan:
    post:
      tags:
        - Cloud
      summary: Change plan
      description: >-
        Moves the server to another plan on the same hardware. Upgrades with
        something to pay raise an UNPAID invoice (due in

        7 days) for the prorated difference and land when it's paid — `applied:
        false`. Downgrades, sideways moves and zero-cost

        upgrades apply immediately and pay unused value back as extra days on
        the renewal date — `applied: true`. When the

        target plan's disk is smaller you must send `diskStrategy`: `keep`
        carries the extra disk as a paid customisation,

        `reinstall` rebuilds at the smaller size and loses the data. Session
        auth only; owner or team ADMIN.

        409 when it's the current plan, another change or upgrade is unpaid, a
        disk decision is needed (`data.needsDiskDecision`

        and `data.disk` are returned), or extra disk can't be sold on this
        hardware. 503 if the plan can't be priced in the

        service currency. Writes an `ORDER_CLOUD_PLAN_CHANGE` audit entry when
        an invoice is raised.
      operationId: publicCloudChangePlan
      parameters:
        - name: id
          in: path
          required: true
          description: Service id of the cloud server.
          schema:
            type: string
            format: uuid
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - plan
              properties:
                plan:
                  type: string
                  description: Target plan slug from GET /v1/cloud/{id}/plan.
                diskStrategy:
                  type: string
                  enum:
                    - keep
                    - reinstall
                  description: >-
                    Required when the target plan has a smaller disk. Defaults
                    to keep otherwise.
      responses:
        '200':
          description: Applied now, or invoiced.
          content:
            application/json:
              schema:
                type: object
                required:
                  - success
                  - data
                properties:
                  success:
                    type: boolean
                    const: true
                  data:
                    oneOf:
                      - $ref: '#/components/schemas/PublicCloudPlanChangeApplied'
                      - $ref: '#/components/schemas/PublicCloudPlanChangeInvoiced'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '409':
          $ref: '#/components/responses/Conflict'
        '500':
          $ref: '#/components/responses/ServerError'
        '503':
          description: >-
            The server isn't built yet, or the plan can't be priced in the
            service currency right now.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - bearerAuth: []
components:
  schemas:
    PublicCloudPlanChangeApplied:
      allOf:
        - $ref: '#/components/schemas/PublicCloudPlanChangeQuote'
        - type: object
          required:
            - applied
            - newRenewalDate
            - reinstallRequired
          properties:
            applied:
              type: boolean
              const: true
            newRenewalDate:
              type:
                - string
                - 'null'
              format: date-time
            reinstallRequired:
              type: boolean
              description: True when the disk shrinks and you chose reinstall.
    PublicCloudPlanChangeInvoiced:
      allOf:
        - $ref: '#/components/schemas/PublicCloudPlanChangeQuote'
        - type: object
          required:
            - applied
            - invoiceId
            - invoiceNumber
            - total
            - currency
          properties:
            applied:
              type: boolean
              const: false
            invoiceId:
              type: string
            invoiceNumber:
              type: string
            total:
              type: integer
              description: Invoice total including tax, minor units.
            currency:
              type: string
    ErrorResponse:
      type: object
      required:
        - success
        - error
      properties:
        success:
          type: boolean
          const: false
        error:
          type: string
          description: Human-readable error message.
      additionalProperties: true
    PublicCloudPlanChangeQuote:
      type: object
      required:
        - direction
        - dueNowMinor
        - creditMinor
        - extraDays
        - newMonthlyMinor
        - oldMonthlyMinor
      properties:
        direction:
          type: string
          enum:
            - upgrade
            - downgrade
            - sideways
        dueNowMinor:
          type: integer
          description: Due now before tax; always 0 on a downgrade.
        creditMinor:
          type: integer
          description: Unused value given back as time; 0 on an upgrade.
        extraDays:
          type: integer
          description: Days the renewal date moves out by; 0 on an upgrade.
        newMonthlyMinor:
          type: integer
        oldMonthlyMinor:
          type: integer
  responses:
    BadRequest:
      description: Validation failed or the request is malformed.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    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'
    Conflict:
      description: The request conflicts with the resource's current state.
      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.