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

# List top-ups

> ### Overview

Lists the account's 50 most recent top-ups, newest first, across all teams. Older top-ups are not included. `credit` contains the same information as the balance endpoint. `enabled` indicates whether top-ups are available.

### Permissions

Requires the account permission `billing.read` (View billing).



## OpenAPI

````yaml https://console.advinservers.com/docs/openapi.json get /billing/deposits
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:
  /billing/deposits:
    get:
      tags:
        - Billing
      summary: List top-ups
      description: >-
        ### Overview


        Lists the account's 50 most recent top-ups, newest first, across all
        teams. Older top-ups are not included. `credit` contains the same
        information as the balance endpoint. `enabled` indicates whether top-ups
        are available.


        ### Permissions


        Requires the account permission `billing.read` (View billing).
      operationId: client.billing.deposits.index
      responses:
        '200':
          description: The record, as a JSON object. There is no envelope.
          content:
            application/json:
              schema:
                type: object
                examples:
                  - enabled: true
                    credit:
                      enabled: true
                      balance: '10.00'
                      limit: '1000.00'
                      headroom: '990.00'
                      currency: USD
                      minimum: '5.00'
                      maximum: '500.00'
                      presets:
                        - '25.00'
                        - '50.00'
                        - '100.00'
                        - '250.00'
                    items:
                      - uuid: 20a09a3f-a6cf-4470-b078-7330235aa5d5
                        status: pending_payment
                        status_label: Awaiting payment
                        billing:
                          service_id: null
                          invoice_id: 18386
                          invoice_url: >-
                            https://clients.advinservers.com/viewinvoice.php?id=18386
                          checkout_uuid: 53a832f9-e85e-44b5-af03-2ef26110686d
                          invoice_status: Unpaid
                          amount: '25.00'
                          currency: USD
                          billing_cycle: null
                          payment_due_at: '2026-09-14T17:12:09+00:00'
                          payment_window_minutes: null
                          paid_at: null
                        credited_at: null
                        cancelled_at: null
                        created_at: '2026-09-14T16:42:09+00:00'
                properties:
                  enabled:
                    type: boolean
                    description: The value of `enabled`.
                    examples:
                      - true
                  credit:
                    description: The available account credit, formatted for display.
                    examples:
                      - enabled: true
                        balance: '10.00'
                        limit: '1000.00'
                        headroom: '990.00'
                        currency: USD
                        minimum: '5.00'
                        maximum: '500.00'
                        presets:
                          - '25.00'
                          - '50.00'
                          - '100.00'
                          - '250.00'
                    allOf:
                      - $ref: '#/components/schemas/AccountCreditData'
                  items:
                    type: array
                    description: >-
                      Recent top-ups with amounts, statuses and payment details
                      for unpaid entries.
                    examples:
                      - - uuid: 20a09a3f-a6cf-4470-b078-7330235aa5d5
                          status: pending_payment
                          status_label: Awaiting payment
                          billing:
                            service_id: null
                            invoice_id: 18386
                            invoice_url: >-
                              https://clients.advinservers.com/viewinvoice.php?id=18386
                            checkout_uuid: 53a832f9-e85e-44b5-af03-2ef26110686d
                            invoice_status: Unpaid
                            amount: '25.00'
                            currency: USD
                            billing_cycle: null
                            payment_due_at: '2026-09-14T17:12:09+00:00'
                            payment_window_minutes: null
                            paid_at: null
                          credited_at: null
                          cancelled_at: null
                          created_at: '2026-09-14T16:42:09+00:00'
                    items:
                      $ref: '#/components/schemas/FundDepositData'
                required:
                  - enabled
                  - credit
                  - items
        '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
        '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:
    AccountCreditData:
      type: object
      description: The account credit balance and limits for adding funds.
      examples:
        - enabled: true
          balance: '10.00'
          limit: '1000.00'
          headroom: '990.00'
          currency: USD
          minimum: '5.00'
          maximum: '500.00'
          presets:
            - '25.00'
            - '50.00'
            - '100.00'
            - '250.00'
      properties:
        enabled:
          type: boolean
          description: The value of `enabled`.
          examples:
            - true
        balance:
          type: string
          description: The value of `balance`.
          examples:
            - '10.00'
        limit:
          type:
            - string
            - 'null'
          description: The value of `limit`.
          examples:
            - '1000.00'
        headroom:
          type:
            - string
            - 'null'
          description: The value of `headroom`.
          examples:
            - '990.00'
        currency:
          type:
            - string
            - 'null'
          description: The three-letter currency code used for monetary amounts.
          examples:
            - USD
        minimum:
          type: string
          description: The value of `minimum`.
          examples:
            - '5.00'
        maximum:
          type: string
          description: The value of `maximum`.
          examples:
            - '500.00'
        presets:
          type: array
          description: The value of `presets`.
          examples:
            - - '25.00'
              - '50.00'
              - '100.00'
              - '250.00'
          items:
            type: string
      required:
        - enabled
        - balance
        - limit
        - headroom
        - currency
        - minimum
        - maximum
        - presets
      title: AccountCreditData
    FundDepositData:
      type: object
      description: An account credit top-up and its payment status.
      examples:
        - uuid: 20a09a3f-a6cf-4470-b078-7330235aa5d5
          status: pending_payment
          status_label: Awaiting payment
          billing:
            service_id: null
            invoice_id: 18386
            invoice_url: https://clients.advinservers.com/viewinvoice.php?id=18386
            checkout_uuid: 53a832f9-e85e-44b5-af03-2ef26110686d
            invoice_status: Unpaid
            amount: '25.00'
            currency: USD
            billing_cycle: null
            payment_due_at: '2026-09-14T17:12:09+00:00'
            payment_window_minutes: null
            paid_at: null
          credited_at: null
          cancelled_at: null
          created_at: '2026-09-14T16:42:09+00:00'
      properties:
        uuid:
          type: string
          description: The uuid UUID.
          examples:
            - 20a09a3f-a6cf-4470-b078-7330235aa5d5
        status:
          type: string
          description: The value of `status`.
          enum:
            - pending_payment
            - credited
            - expired
            - cancelled
            - payment_review
          examples:
            - pending_payment
        status_label:
          type: string
          description: The status in the customer's words, written once on the enum.
          examples:
            - Awaiting payment
        billing:
          $ref: '#/components/schemas/BillingData'
          description: The value of `billing`.
          examples:
            - service_id: null
              invoice_id: 18386
              invoice_url: https://clients.advinservers.com/viewinvoice.php?id=18386
              checkout_uuid: 53a832f9-e85e-44b5-af03-2ef26110686d
              invoice_status: Unpaid
              amount: '25.00'
              currency: USD
              billing_cycle: null
              payment_due_at: '2026-09-14T17:12:09+00:00'
              payment_window_minutes: null
              paid_at: null
        credited_at:
          type:
            - string
            - 'null'
          description: The date and time for credited at, in UTC.
          examples:
            - null
        cancelled_at:
          type:
            - string
            - 'null'
          description: The date and time for cancelled at, in UTC.
          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'
      required:
        - uuid
        - status
        - status_label
        - billing
        - credited_at
        - cancelled_at
        - created_at
      title: FundDepositData
    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.