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

# Preview the credit from a move to a postpaid team

> ### Overview

Takes the same `team` and `moves` as the transfer endpoint and says what the move would do to billing, without moving or changing anything. Use it before sending `accept_postpaid: true`.

`ends_prepaid_billing` is true when the move would end prepaid billing for any of the resources. `credit` is then the unused paid time that would be added to account credit, as a decimal string in `currency`. Both are null when the move would not change how anything is billed. The amount is worked out for the current moment, so the move itself may credit slightly less a few minutes later.

The same checks as the move apply, so a move that would be refused is refused here with the same reason.

### Permissions

Requires one of the `server.transfer` (Transfer servers to their own account), `network.transfer` (Transfer floating IPs to their own account) or `snapshot.transfer` (Transfer snapshot storage to their own account) permissions for the selected team, depending on the request. Resources outside that team return 404.



## OpenAPI

````yaml https://console.advinservers.com/docs/openapi.json post /transfers/quote
openapi: 3.1.2
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. They cannot be
      deleted, and they are kept when the server is deleted.
  - 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 address lists for the source or destination of 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: Domain name
    description: Give a server its own domain name that points at one of its IP addresses.
  - 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:
  /transfers/quote:
    post:
      tags:
        - Transfers
      summary: Preview the credit from a move to a postpaid team
      description: >-
        ### Overview


        Takes the same `team` and `moves` as the transfer endpoint and says what
        the move would do to billing, without moving or changing anything. Use
        it before sending `accept_postpaid: true`.


        `ends_prepaid_billing` is true when the move would end prepaid billing
        for any of the resources. `credit` is then the unused paid time that
        would be added to account credit, as a decimal string in `currency`.
        Both are null when the move would not change how anything is billed. The
        amount is worked out for the current moment, so the move itself may
        credit slightly less a few minutes later.


        The same checks as the move apply, so a move that would be refused is
        refused here with the same reason.


        ### Permissions


        Requires one of the `server.transfer` (Transfer servers to their own
        account), `network.transfer` (Transfer floating IPs to their own
        account) or `snapshot.transfer` (Transfer snapshot storage to their own
        account) permissions for the selected team, depending on the request.
        Resources outside that team return 404.
      operationId: client.transfers.quote
      requestBody:
        description: >-
          Send a JSON object containing the fields below. Required fields are
          marked in the schema.
        required: true
        content:
          application/json:
            schema:
              examples:
                - moves:
                    - resource: server
                      uuids:
                        - ecc6f4f1-c89b-4dce-a20b-a330641c5b0b
                        - 304e1794-a5b7-41f2-9a20-c0d444eb6683
                    - resource: iso
                      uuids:
                        - ec4fa5b5-cc7c-4fcf-b280-ee55eca8d44b
                    - resource: firewall_group
                      uuids:
                        - 72a4a737-236f-456f-827f-6145d9c95727
                    - resource: firewall_ip_group
                      uuids:
                        - 145e6e6f-a6b0-4b9e-9060-2d4f017baff8
                    - resource: private_network
                      uuids:
                        - 5220f263-0e8e-4917-bf4f-4cae109ca4c5
                    - resource: floating_ip
                      uuids:
                        - 1b8349e5-3568-43e0-bf89-fc3350dd7a08
                  team: 48454223-c5ac-461f-bead-ba8dda13eea9
              allOf:
                - $ref: '#/components/schemas/TransferResourcesRequest'
      responses:
        '200':
          description: The record, as a JSON object. There is no envelope.
          content:
            application/json:
              schema:
                type: object
                examples:
                  - ends_prepaid_billing: true
                    credit: '4.12'
                    currency: USD
                properties:
                  ends_prepaid_billing:
                    type: boolean
                    description: The value of `ends_prepaid_billing`.
                    examples:
                      - true
                  credit:
                    type:
                      - string
                      - 'null'
                    description: The available account credit, formatted for display.
                    examples:
                      - '4.12'
                  currency:
                    type:
                      - string
                      - 'null'
                    description: The three-letter currency code used for monetary amounts.
                    examples:
                      - USD
                required:
                  - ends_prepaid_billing
                  - credit
                  - currency
        '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
        '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:
    TransferResourcesRequest:
      type: object
      examples:
        - moves:
            - resource: server
              uuids:
                - ecc6f4f1-c89b-4dce-a20b-a330641c5b0b
                - 304e1794-a5b7-41f2-9a20-c0d444eb6683
            - resource: iso
              uuids:
                - ec4fa5b5-cc7c-4fcf-b280-ee55eca8d44b
            - resource: firewall_group
              uuids:
                - 72a4a737-236f-456f-827f-6145d9c95727
            - resource: firewall_ip_group
              uuids:
                - 145e6e6f-a6b0-4b9e-9060-2d4f017baff8
            - resource: private_network
              uuids:
                - 5220f263-0e8e-4917-bf4f-4cae109ca4c5
            - resource: floating_ip
              uuids:
                - 1b8349e5-3568-43e0-bf89-fc3350dd7a08
          team: 48454223-c5ac-461f-bead-ba8dda13eea9
      properties:
        moves:
          type: array
          description: The value of `moves`.
          items:
            type: object
            properties:
              resource:
                type: string
                description: The type of resource this entry describes.
                enum:
                  - server
                  - ssh_key
                  - user_script
                  - iso
                  - firewall_group
                  - firewall_ip_group
                  - private_network
                  - floating_ip
                  - snapshot_storage
                  - website_hosting
                  - license
              uuids:
                type: array
                description: The resource UUIDs to act on.
                items:
                  type: string
                  minLength: 36
                  maxLength: 36
                minItems: 1
            required:
              - resource
              - uuids
          minItems: 1
          maxItems: 11
        team:
          type: string
          description: The destination team UUID.
          minLength: 36
          maxLength: 36
        accept_postpaid:
          type: boolean
          description: The value of `accept_postpaid`.
      required:
        - moves
        - team
      title: TransferResourcesRequest
  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.