> ## 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 a quote for a plan change

> ### Overview

Calculates the price of a plan change. Send `plan_key` from the catalogue and `resize_disk`.

The response includes the price, any location change fee, currency, remaining and total days in the current billing period, destination, migration requirements, IP replacement requirements and a signed `quote_token`. Use this token to purchase the change at the quoted price. A quote does not charge the account or reserve capacity. If the plan has no available capacity, the response explains why a quote cannot be provided. A plan the catalogue listed as available in the last ten minutes is quoted even if that capacity has since been taken, and purchasing with the resulting `quote_token` honors it the same way.

### 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 post /servers/{server}/upgrades/quote
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/quote:
    post:
      tags:
        - Server upgrades
      summary: Get a quote for a plan change
      description: >-
        ### Overview


        Calculates the price of a plan change. Send `plan_key` from the
        catalogue and `resize_disk`.


        The response includes the price, any location change fee, currency,
        remaining and total days in the current billing period, destination,
        migration requirements, IP replacement requirements and a signed
        `quote_token`. Use this token to purchase the change at the quoted
        price. A quote does not charge the account or reserve capacity. If the
        plan has no available capacity, the response explains why a quote cannot
        be provided. A plan the catalogue listed as available in the last ten
        minutes is quoted even if that capacity has since been taken, and
        purchasing with the resulting `quote_token` honors it the same way.


        ### Permissions


        Requires the `server.read` (View servers) permission for the selected
        team. Resources outside that team return 404.
      operationId: client.servers.upgrades.quote
      parameters:
        - name: server
          in: path
          required: true
          description: The server UUID
          schema:
            type: string
            examples:
              - ecc6f4f1
          example: ecc6f4f1
      requestBody:
        description: >-
          Send a JSON object containing the fields below. Required fields are
          marked in the schema.
        required: true
        content:
          application/json:
            schema:
              examples:
                - plan_key: >-
                    84ee2bf7fc22f495e76aead064154e1d5ae66fee1ac71cda7cf48d9e607a60bc
                  resize_disk: true
              allOf:
                - $ref: '#/components/schemas/QuoteServerUpgradeRequest'
      responses:
        '200':
          description: The record, as a JSON object. There is no envelope.
          content:
            application/json:
              schema:
                type: object
                examples:
                  - amount: '6.00'
                    refund_amount: '0.00'
                    location_change_fee: '0.00'
                    currency: USD
                    days_remaining: 18
                    total_days: 30
                    billing_cycle: Monthly
                    current_recurring_amount: '12.00'
                    target_recurring_amount: '22.00'
                    quote_token: >-
                      eyJpdiI6InZVUENaRU81VXMyL1psak9tNS8xTGc9PSIsInZhbHVlIjoib2JiS0ZkbXVmREY0OXBHeXorZEx5Wi81Z3F1UzF0L3RENFBnNTFIZHJ6YUl3RGZYclUrbWoydFpOYkkyT1Q2SklmbVlYdGU4WEVHaWlPRHBQbExSUnp4VkdZbk1ZY0JRZ0U4d0NNbDB1eFVSbVFIZ0xkdkxLdDZzZTZodkFZdEFqV3dBTk1HaTVPNWRpTmpJdjlQSEVNNjZjYWV1UnhGUW1pTEovY2VSQUdPMEg3MDRldWxEN2tBc0Rzd1VEK2pNa01uNEx1bXlLSExZUldobUw0ODVWbWlNZjlKRWIvTFJlaThQd1A0S2kwY3dFejgrZ2NmczZlWGdLVENRL1VoelBJczJ0LzgxMTBXZnlOaFRHSEplRk0zWTQ5cXZHRXhlUGFyV292ZGRHN0FpaWtVVzZhUnFBOGRLcm40TUx3TFIiLCJtYWMiOiJhNmViM2NiYTY0OWI5ZTUxMDkzNGQxYjBkMjRmMWIzZTg2NWE4MWMzYjk2YjIxZDc1NTAyMThjMTliYWQzZGM2IiwidGFnIjoiIn0=
                    plan_key: >-
                      84ee2bf7fc22f495e76aead064154e1d5ae66fee1ac71cda7cf48d9e607a60bc
                    plan_name: Standard 8 GB
                    source_location_id: 3
                    target_location_id: 3
                    source_location: Kansas City, MO
                    target_location: Kansas City, MO
                    requires_migration: false
                    requires_ip_replacement: false
                    resize_disk: true
                properties:
                  amount:
                    type: string
                    description: The amount in the currency shown by `currency`.
                    examples:
                      - '6.00'
                  refund_amount:
                    type: string
                    description: The value of `refund_amount`.
                    examples:
                      - '0.00'
                  location_change_fee:
                    type: string
                    description: The value of `location_change_fee`.
                    examples:
                      - '0.00'
                  currency:
                    type: string
                    description: The three-letter currency code used for monetary amounts.
                    examples:
                      - USD
                  days_remaining:
                    type: integer
                    description: The value of `days_remaining`.
                    examples:
                      - 18
                  total_days:
                    type: integer
                    description: The value of `total_days`.
                    examples:
                      - 30
                  billing_cycle:
                    type: string
                    description: How often the service renews and is billed.
                    examples:
                      - Monthly
                  current_recurring_amount:
                    type: string
                    description: The value of `current_recurring_amount`.
                    examples:
                      - '12.00'
                  target_recurring_amount:
                    type: string
                    description: The value of `target_recurring_amount`.
                    examples:
                      - '22.00'
                  quote_token:
                    type: string
                    description: The value of `quote_token`.
                    examples:
                      - >-
                        eyJpdiI6InZVUENaRU81VXMyL1psak9tNS8xTGc9PSIsInZhbHVlIjoib2JiS0ZkbXVmREY0OXBHeXorZEx5Wi81Z3F1UzF0L3RENFBnNTFIZHJ6YUl3RGZYclUrbWoydFpOYkkyT1Q2SklmbVlYdGU4WEVHaWlPRHBQbExSUnp4VkdZbk1ZY0JRZ0U4d0NNbDB1eFVSbVFIZ0xkdkxLdDZzZTZodkFZdEFqV3dBTk1HaTVPNWRpTmpJdjlQSEVNNjZjYWV1UnhGUW1pTEovY2VSQUdPMEg3MDRldWxEN2tBc0Rzd1VEK2pNa01uNEx1bXlLSExZUldobUw0ODVWbWlNZjlKRWIvTFJlaThQd1A0S2kwY3dFejgrZ2NmczZlWGdLVENRL1VoelBJczJ0LzgxMTBXZnlOaFRHSEplRk0zWTQ5cXZHRXhlUGFyV292ZGRHN0FpaWtVVzZhUnFBOGRLcm40TUx3TFIiLCJtYWMiOiJhNmViM2NiYTY0OWI5ZTUxMDkzNGQxYjBkMjRmMWIzZTg2NWE4MWMzYjk2YjIxZDc1NTAyMThjMTliYWQzZGM2IiwidGFnIjoiIn0=
                  plan_key:
                    type: string
                    description: The value of `plan_key`.
                    examples:
                      - >-
                        84ee2bf7fc22f495e76aead064154e1d5ae66fee1ac71cda7cf48d9e607a60bc
                  plan_name:
                    type: string
                    description: The value of `plan_name`.
                    examples:
                      - Standard 8 GB
                  source_location_id:
                    type: integer
                    description: The source location id ID.
                    examples:
                      - 3
                  target_location_id:
                    type: integer
                    description: The target location id ID.
                    examples:
                      - 3
                  source_location:
                    type: string
                    description: The value of `source_location`.
                    examples:
                      - Kansas City, MO
                  target_location:
                    type: string
                    description: The value of `target_location`.
                    examples:
                      - Kansas City, MO
                  requires_migration:
                    type: boolean
                    description: Whether this action requires migration.
                    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
                required:
                  - amount
                  - refund_amount
                  - location_change_fee
                  - currency
                  - days_remaining
                  - total_days
                  - billing_cycle
                  - current_recurring_amount
                  - target_recurring_amount
                  - quote_token
                  - plan_key
                  - plan_name
                  - source_location_id
                  - target_location_id
                  - source_location
                  - target_location
                  - requires_migration
                  - requires_ip_replacement
                  - resize_disk
        '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
        '422':
          description: >-
            A field is missing or invalid, or the resource cannot accept this
            change in its current state. Check `message` for details. Field
            validation also includes an `errors` object keyed by field name.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    description: >-
                      A summary of the validation error or the reason the change
                      was refused.
                    examples:
                      - The name field is required.
                  errors:
                    type: object
                    description: Validation errors grouped by field name.
                    additionalProperties:
                      type: array
                      items:
                        type: string
                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:
    QuoteServerUpgradeRequest:
      type: object
      examples:
        - plan_key: 84ee2bf7fc22f495e76aead064154e1d5ae66fee1ac71cda7cf48d9e607a60bc
          resize_disk: true
      properties:
        plan_key:
          type: string
          description: The value of `plan_key`.
          minLength: 64
          maxLength: 64
        resize_disk:
          type: boolean
          description: The value of `resize_disk`.
      required:
        - plan_key
        - resize_disk
      title: QuoteServerUpgradeRequest
  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.