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

# Get the current plan change

> ### Overview

Returns the current plan change, including its status, progress percentage, progress message and any failure reference. Returns **204 with no body** if there is no current change. Completed changes remain available for one day. Changes awaiting billing review remain available until the review is recorded.

### Permissions

Requires the `server.read` (View servers) permission for the selected team. Resources outside that team return 404.



## OpenAPI

````yaml https://console.advinservers.com/docs/openapi.json get /servers/{server}/upgrades/current
openapi: 3.1.0
info:
  title: API reference
  version: 1.0.0
  description: >-
    Use this API to manage your team's servers, networks, backups, and other
    resources.


    ## Authentication


    Create an API key under **API Keys** and send it as a bearer token with
    every request:


    ```

    Authorization: Bearer {YOUR_API_KEY}

    Accept: application/json

    ```


    Copy the key when you create it. It cannot be shown again. Revoking a key
    takes effect immediately.


    ## Permissions


    Give each key only the permissions it needs. Every endpoint lists the
    required permission.


    Permissions cover servers and other resources in the key's team.


    ## Team scope


    A key can access resources in the team selected when it was created. This
    includes servers,

    snapshots, backups, firewall groups, images, SSH keys, scripts, networks and
    addresses.

    Resources in other teams return `404 Not Found`. Create a separate key for
    each team.


    The key determines the team for every request. Legacy keys that had no team
    are assigned

    to the account's first owned team.


    ## Actions that need the panel


    API keys cannot do the following, even with every permission. Sign in to the
    panel in a

    browser to do them:


    - Create, edit or revoke API keys

    - Edit the IP groups that restrict API keys

    - End signed-in sessions

    - Change two-factor authentication

    - Change the account's email address

    - Accept or decline team invitations

    - Switch or leave a team


    This keeps a leaked key from widening its own access or locking you out of
    your account.


    ## Source IP restrictions


    A key can be restricted to one or more IP groups. Requests from other
    addresses are rejected.


    ## Requests and responses


    Each endpoint lists its path, query, header, and body parameters. Examples
    use fictional data.


    Single records use JSON objects. Collections use JSON arrays unless the
    endpoint supports pagination. Timestamps use ISO 8601 in UTC.


    Error responses include `message`. Validation errors also include an
    `errors` object for each field. Each endpoint lists its status codes.


    ## Audit log


    Every API request, including reads, is recorded in the account audit log
    with the key that made it.
servers:
  - url: https://console.advinservers.com/api/v1/client
security:
  - http: []
tags:
  - name: Account
    description: Billing contact details and account setup progress.
  - name: Account activity
    description: Actions performed in the current team by people and API keys.
  - name: Servers
    description: >-
      Order and list servers, read their state and resource use, open a console,
      and control power.
  - name: Server settings
    description: >-
      Rename a server, rebuild it, and change its hardware, media, resolvers and
      credentials.
  - name: Backups
    description: Scheduled server copies stored separately from the server.
  - name: Snapshots
    description: >-
      Take, restore and move server snapshots. Snapshots are kept in snapshot
      storage that the team buys by the GiB.
  - name: Firewall groups
    description: Reusable sets of firewall rules, and the servers they apply to.
  - name: IP groups
    description: Reusable source address lists for firewall rules.
  - name: Server firewall
    description: >-
      Read default traffic policies and rules managed outside your firewall
      groups.
  - name: IP addresses
    description: Manage floating IPs and server address assignments.
  - name: Private networks
    description: Connect servers over a private network in the same location.
  - name: Reverse DNS
    description: Set the hostnames returned by IP address lookups.
  - name: DDoS protection
    description: Configure attack filtering for server addresses.
  - name: Bandwidth
    description: Buy extra bandwidth and share it between servers or location pools.
  - name: SSH keys
    description: Public keys the account can install on a server when it is built.
  - name: Setup scripts
    description: Scripts the account can run on a server when it is built.
  - name: ISO images
    description: ISO images you have downloaded, and the servers they are mounted on.
  - name: Server upgrades
    description: Change an existing server's plan.
  - name: Checkout
    description: Choose a payment method and pay for a purchase.
  - name: Invoices
    description: View and pay account invoices.
  - name: Billing
    description: Manage service renewals, payment methods and account credit.
  - name: Transfers
    description: Move resources between teams or transfer ownership.
  - name: Teams
    description: Manage the team assigned to your API key.
  - name: Team members
    description: Invite people and manage their team access.
  - name: Team roles
    description: Define the permissions granted to team members.
  - name: Team activity
    description: View actions performed in a team.
  - name: Support tickets
    description: >-
      Open, read, reply to and close support tickets. Tickets belong to the
      account holder and are not shared with team members.
paths:
  /servers/{server}/upgrades/current:
    get:
      tags:
        - Server upgrades
      summary: Get the current plan change
      description: >-
        ### Overview


        Returns the current plan change, including its status, progress
        percentage, progress message and any failure reference. Returns **204
        with no body** if there is no current change. Completed changes remain
        available for one day. Changes awaiting billing review remain available
        until the review is recorded.


        ### Permissions


        Requires the `server.read` (View servers) permission for the selected
        team. Resources outside that team return 404.
      operationId: client.servers.upgrades.current
      parameters:
        - name: server
          in: path
          required: true
          description: The server UUID
          schema:
            type: string
            examples:
              - ecc6f4f1
          example: ecc6f4f1
      responses:
        '200':
          description: The record, as a JSON object. There is no envelope.
          content:
            application/json:
              schema:
                examples:
                  - uuid: 2946b7c6-1b8d-4279-880f-629c9dd8f48c
                    status: pending_payment
                    status_label: Paying from account credit
                    stage: awaiting_billing
                    progress: 0
                    progress_message: Paying for the change from your account credit.
                    location_change_fee: '0.00'
                    billing:
                      service_id: null
                      invoice_id: null
                      invoice_url: null
                      checkout_uuid: null
                      invoice_status: null
                      amount: '6.00'
                      currency: USD
                      billing_cycle: null
                      payment_due_at: '2026-09-14T17:12:09+00:00'
                      payment_window_minutes: null
                      paid_at: null
                    source_location: Kansas City, MO
                    target_location: Kansas City, MO
                    requires_migration: false
                    crosses_location: false
                    requires_ip_replacement: false
                    resize_disk: true
                    plan_name: Standard 8 GB
                    product_group_name: Standard VPS
                    source_cpu: 4
                    source_memory: 4294967296
                    source_disk: 85899345920
                    source_bandwidth: 5497558138880
                    target_cpu: 6
                    target_memory: 8589934592
                    target_disk: 171798691840
                    target_bandwidth: 10995116277760
                    transferred_bytes: null
                    total_bytes: null
                    can_cancel: true
                    error: null
                    support_reference: null
                    created_at: '2026-09-14T16:42:09+00:00'
                    started_at: null
                    completed_at: null
                allOf:
                  - $ref: '#/components/schemas/ServerUpgradeData'
        '204':
          description: There is no current plan change.
        '401':
          description: >-
            The key was missing, malformed, revoked, or belongs to an account
            that no longer exists.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    examples:
                      - Unauthenticated.
                required:
                  - message
        '403':
          description: >-
            Access denied. Check the key's team, permissions and allowed IP
            addresses. Some actions, such as managing API keys, require a
            browser session. The response message explains the reason.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    examples:
                      - >-
                        This API key is not allowed to do that in this team. It
                        needs the "snapshot.delete" permission.
                required:
                  - message
        '404':
          description: >-
            The resource was not found in the selected team. Resources in
            another account or team also return 404.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    examples:
                      - Not found.
                required:
                  - message
        '429':
          description: >-
            Too many requests. The `Retry-After` header says how many seconds to
            wait. Limits are per account, so several keys on one account share
            them.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    examples:
                      - Too Many Attempts.
                required:
                  - message
components:
  schemas:
    ServerUpgradeData:
      type: object
      description: A plan change, as the customer who bought it is shown one.
      examples:
        - uuid: 2946b7c6-1b8d-4279-880f-629c9dd8f48c
          status: pending_payment
          status_label: Paying from account credit
          stage: awaiting_billing
          progress: 0
          progress_message: Paying for the change from your account credit.
          location_change_fee: '0.00'
          billing:
            service_id: null
            invoice_id: null
            invoice_url: null
            checkout_uuid: null
            invoice_status: null
            amount: '6.00'
            currency: USD
            billing_cycle: null
            payment_due_at: '2026-09-14T17:12:09+00:00'
            payment_window_minutes: null
            paid_at: null
          source_location: Kansas City, MO
          target_location: Kansas City, MO
          requires_migration: false
          crosses_location: false
          requires_ip_replacement: false
          resize_disk: true
          plan_name: Standard 8 GB
          product_group_name: Standard VPS
          source_cpu: 4
          source_memory: 4294967296
          source_disk: 85899345920
          source_bandwidth: 5497558138880
          target_cpu: 6
          target_memory: 8589934592
          target_disk: 171798691840
          target_bandwidth: 10995116277760
          transferred_bytes: null
          total_bytes: null
          can_cancel: true
          error: null
          support_reference: null
          created_at: '2026-09-14T16:42:09+00:00'
          started_at: null
          completed_at: null
      properties:
        uuid:
          type: string
          description: The uuid UUID.
          examples:
            - 2946b7c6-1b8d-4279-880f-629c9dd8f48c
        status:
          type: string
          description: The value of `status`.
          enum:
            - pending_payment
            - queued
            - stopping
            - migrating
            - resizing
            - networking
            - finalizing
            - completed
            - failed
            - expired
            - payment_review
            - cancelled
          examples:
            - pending_payment
        status_label:
          type: string
          description: The value of `status_label`.
          examples:
            - Paying from account credit
        stage:
          type:
            - string
            - 'null'
          description: The value of `stage`.
          examples:
            - awaiting_billing
        progress:
          type: integer
          description: The value of `progress`.
          examples:
            - 0
        progress_message:
          type:
            - string
            - 'null'
          description: The value of `progress_message`.
          examples:
            - Paying for the change from your account credit.
        location_change_fee:
          type:
            - string
            - 'null'
          description: The value of `location_change_fee`.
          examples:
            - '0.00'
        billing:
          $ref: '#/components/schemas/BillingData'
          description: The value of `billing`.
          examples:
            - service_id: null
              invoice_id: null
              invoice_url: null
              checkout_uuid: null
              invoice_status: null
              amount: '6.00'
              currency: USD
              billing_cycle: null
              payment_due_at: '2026-09-14T17:12:09+00:00'
              payment_window_minutes: null
              paid_at: null
        source_location:
          type:
            - string
            - 'null'
          description: The value of `source_location`.
          examples:
            - Kansas City, MO
        target_location:
          type:
            - string
            - 'null'
          description: The value of `target_location`.
          examples:
            - Kansas City, MO
        requires_migration:
          type: boolean
          description: Whether this action requires migration.
          examples:
            - false
        crosses_location:
          type: boolean
          description: The value of `crosses_location`.
          examples:
            - false
        requires_ip_replacement:
          type: boolean
          description: Whether this action requires ip replacement.
          examples:
            - false
        resize_disk:
          type: boolean
          description: The value of `resize_disk`.
          examples:
            - true
        plan_name:
          type:
            - string
            - 'null'
          description: The value of `plan_name`.
          examples:
            - Standard 8 GB
        product_group_name:
          type:
            - string
            - 'null'
          description: The value of `product_group_name`.
          examples:
            - Standard VPS
        source_cpu:
          type:
            - integer
            - 'null'
          description: >-
            The plan the customer bought, spelled out against what the server
            has today. These are the snapshot taken at checkout, so they keep
            describing the change even after the feed moves on.
          examples:
            - 4
        source_memory:
          type:
            - integer
            - 'null'
          description: The value of `source_memory`.
          examples:
            - 4294967296
        source_disk:
          type:
            - integer
            - 'null'
          description: The value of `source_disk`.
          examples:
            - 85899345920
        source_bandwidth:
          type:
            - integer
            - 'null'
          description: The value of `source_bandwidth`.
          examples:
            - 5497558138880
        target_cpu:
          type:
            - integer
            - 'null'
          description: The value of `target_cpu`.
          examples:
            - 6
        target_memory:
          type:
            - integer
            - 'null'
          description: The value of `target_memory`.
          examples:
            - 8589934592
        target_disk:
          type:
            - integer
            - 'null'
          description: The value of `target_disk`.
          examples:
            - 171798691840
        target_bandwidth:
          type:
            - integer
            - 'null'
          description: The value of `target_bandwidth`.
          examples:
            - 10995116277760
        transferred_bytes:
          type:
            - integer
            - 'null'
          description: The value of `transferred_bytes`.
          examples:
            - null
        total_bytes:
          type:
            - integer
            - 'null'
          description: The value of `total_bytes`.
          examples:
            - null
        can_cancel:
          type: boolean
          description: Whether the customer can cancel.
          examples:
            - true
        error:
          type:
            - string
            - 'null'
          description: >-
            A customer-safe explanation of the failure. Internal billing
            diagnostics are never published here.
          examples:
            - null
        support_reference:
          type:
            - string
            - 'null'
          description: The value of `support_reference`.
          examples:
            - null
        created_at:
          type:
            - string
            - 'null'
          description: The date and time for created at, in UTC.
          examples:
            - '2026-09-14T16:42:09+00:00'
        started_at:
          type:
            - string
            - 'null'
          description: The date and time for started at, in UTC.
          examples:
            - null
        completed_at:
          type:
            - string
            - 'null'
          description: The date and time for completed at, in UTC.
          examples:
            - null
      required:
        - uuid
        - status
        - status_label
        - stage
        - progress
        - progress_message
        - location_change_fee
        - billing
        - source_location
        - target_location
        - requires_migration
        - crosses_location
        - requires_ip_replacement
        - resize_disk
        - plan_name
        - product_group_name
        - source_cpu
        - source_memory
        - source_disk
        - source_bandwidth
        - target_cpu
        - target_memory
        - target_disk
        - target_bandwidth
        - transferred_bytes
        - total_bytes
        - can_cancel
        - error
        - support_reference
        - created_at
        - started_at
        - completed_at
      title: ServerUpgradeData
    BillingData:
      type: object
      description: >-
        The billing details shared by customer-owned resources and pending
        orders.
      examples:
        - service_id: 7312
          invoice_id: 15542
          invoice_url: null
          checkout_uuid: null
          invoice_status: Paid
          amount: '12.00'
          currency: USD
          billing_cycle: monthly
          payment_due_at: null
          payment_window_minutes: null
          paid_at: '2026-03-02T19:13:58+00:00'
      properties:
        service_id:
          type:
            - integer
            - 'null'
          description: The customer's service number, once a recurring service exists.
          examples:
            - 7312
        invoice_id:
          type:
            - integer
            - 'null'
          description: The customer's invoice number, once an invoice exists.
          examples:
            - 15542
        invoice_url:
          type:
            - string
            - 'null'
          description: A complete URL where the invoice can be paid.
          examples:
            - null
        checkout_uuid:
          type:
            - string
            - 'null'
          description: The checkout UUID, or null when no checkout is available.
          examples:
            - null
        invoice_status:
          type:
            - string
            - 'null'
          description: The current invoice status, or null before an invoice exists.
          examples:
            - Paid
        amount:
          type:
            - string
            - 'null'
          description: The amount in the currency shown by `currency`.
          examples:
            - '12.00'
        currency:
          type:
            - string
            - 'null'
          description: The three-letter currency code used for `amount`.
          examples:
            - USD
        billing_cycle:
          type:
            - string
            - 'null'
          description: How often the service renews, or null for a one-time charge.
          examples:
            - monthly
        payment_due_at:
          type:
            - string
            - 'null'
          description: When payment is due before the reservation is released.
          examples:
            - null
        payment_window_minutes:
          type:
            - integer
            - 'null'
          description: How many minutes the original payment window allowed.
          examples:
            - null
        paid_at:
          type:
            - string
            - 'null'
          description: When the charge was paid, or null while payment is outstanding.
          examples:
            - '2026-03-02T19:13:58+00:00'
      required:
        - service_id
        - invoice_id
        - invoice_url
        - checkout_uuid
        - invoice_status
        - amount
        - currency
        - billing_cycle
        - payment_due_at
        - payment_window_minutes
        - paid_at
      title: BillingData
  securitySchemes:
    http:
      type: http
      description: >-
        Your API key, sent as a bearer token. Create one in the control panel
        under API Keys, give it only the permissions the integration needs, and
        copy it when it is created. It cannot be shown again. Each key is
        restricted to one owned team. The key determines the team for every
        request.
      scheme: bearer

````

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