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

> ### Overview

Lists account invoices, newest first, without filters or pagination. The list is the same for every team on the account.

Each invoice includes totals. Line items, payments and the remaining balance are omitted; fetch an individual invoice for those details. `statuses` lists possible statuses. `scan_limit` indicates how far back the lookup checked. `truncated` is true if more invoices exist than the lookup returned.

### Permissions

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



## OpenAPI

````yaml https://console.advinservers.com/docs/openapi.json get /invoices
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:
  /invoices:
    get:
      tags:
        - Invoices
      summary: List invoices
      description: >-
        ### Overview


        Lists account invoices, newest first, without filters or pagination. The
        list is the same for every team on the account.


        Each invoice includes totals. Line items, payments and the remaining
        balance are omitted; fetch an individual invoice for those details.
        `statuses` lists possible statuses. `scan_limit` indicates how far back
        the lookup checked. `truncated` is true if more invoices exist than the
        lookup returned.


        ### Permissions


        Requires the account permission `invoices.read` (View invoices).
      operationId: client.invoices.index
      responses:
        '200':
          description: The record, as a JSON object. There is no envelope.
          content:
            application/json:
              schema:
                type: object
                examples:
                  - statuses:
                      - Draft
                      - Unpaid
                      - Overdue
                      - Paid
                      - Cancelled
                      - Refunded
                      - Collections
                      - Payment Pending
                    truncated: false
                    scan_limit: 500
                    items:
                      - id: 18342
                        number: '18342'
                        status: Unpaid
                        date: '2026-09-11T00:00:00+00:00'
                        due_date: '2026-10-02T00:00:00+00:00'
                        date_paid: null
                        subtotal: '12.00'
                        credit: '0.00'
                        tax: '0.00'
                        total: '12.00'
                        currency: USD
                        payment_method: Paddle
                        url: >-
                          https://clients.advinservers.com/viewinvoice.php?id=18342
                      - id: 17906
                        number: '17906'
                        status: Paid
                        date: '2026-08-12T00:00:00+00:00'
                        due_date: '2026-09-02T00:00:00+00:00'
                        date_paid: '2026-09-02T19:15:08+00:00'
                        subtotal: '12.00'
                        credit: '0.00'
                        tax: '0.00'
                        total: '12.00'
                        currency: USD
                        payment_method: Paddle
                        url: >-
                          https://clients.advinservers.com/viewinvoice.php?id=17906
                properties:
                  statuses:
                    type: array
                    description: The value of `statuses`.
                    examples:
                      - - Draft
                        - Unpaid
                        - Overdue
                        - Paid
                        - Cancelled
                        - Refunded
                        - Collections
                        - Payment Pending
                    items:
                      type: string
                      examples:
                        - ''
                  truncated:
                    type: boolean
                    description: The value of `truncated`.
                    examples:
                      - false
                  scan_limit:
                    type: integer
                    description: The value of `scan_limit`.
                    examples:
                      - 500
                  items:
                    type: array
                    description: >-
                      The invoices, newest first, without their line items or
                      payments.
                    examples:
                      - - id: 18342
                          number: '18342'
                          status: Unpaid
                          date: '2026-09-11T00:00:00+00:00'
                          due_date: '2026-10-02T00:00:00+00:00'
                          date_paid: null
                          subtotal: '12.00'
                          credit: '0.00'
                          tax: '0.00'
                          total: '12.00'
                          currency: USD
                          payment_method: Paddle
                          url: >-
                            https://clients.advinservers.com/viewinvoice.php?id=18342
                        - id: 17906
                          number: '17906'
                          status: Paid
                          date: '2026-08-12T00:00:00+00:00'
                          due_date: '2026-09-02T00:00:00+00:00'
                          date_paid: '2026-09-02T19:15:08+00:00'
                          subtotal: '12.00'
                          credit: '0.00'
                          tax: '0.00'
                          total: '12.00'
                          currency: USD
                          payment_method: Paddle
                          url: >-
                            https://clients.advinservers.com/viewinvoice.php?id=17906
                      - - id: 18342
                          number: '18342'
                          status: Unpaid
                          date: '2026-09-11T00:00:00+00:00'
                          due_date: '2026-10-02T00:00:00+00:00'
                          date_paid: null
                          subtotal: '12.00'
                          credit: '0.00'
                          tax: '0.00'
                          total: '12.00'
                          currency: USD
                          payment_method: Paddle
                          url: >-
                            https://clients.advinservers.com/viewinvoice.php?id=18342
                    items:
                      $ref: '#/components/schemas/InvoiceData'
                required:
                  - statuses
                  - truncated
                  - scan_limit
                  - 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:
    InvoiceData:
      type: object
      examples:
        - id: 18342
          number: '18342'
          status: Unpaid
          date: '2026-09-11T00:00:00+00:00'
          due_date: '2026-10-02T00:00:00+00:00'
          date_paid: null
          subtotal: '12.00'
          credit: '0.00'
          tax: '0.00'
          total: '12.00'
          currency: USD
          payment_method: Paddle
          url: https://clients.advinservers.com/viewinvoice.php?id=18342
      properties:
        id:
          type: integer
          description: The id ID.
          examples:
            - 18342
        number:
          type: string
          description: The value of `number`.
          examples:
            - '18342'
        status:
          type: string
          description: The value of `status`.
          examples:
            - Unpaid
        date:
          type:
            - string
            - 'null'
          description: The date and time for date, in UTC.
          examples:
            - '2026-09-11T00:00:00+00:00'
        due_date:
          type:
            - string
            - 'null'
          description: The value of `due_date`.
          examples:
            - '2026-10-02T00:00:00+00:00'
        date_paid:
          type:
            - string
            - 'null'
          description: The value of `date_paid`.
          examples:
            - null
        subtotal:
          type: string
          description: The value of `subtotal`.
          examples:
            - '12.00'
        credit:
          type: string
          description: The available account credit, formatted for display.
          examples:
            - '0.00'
        tax:
          type: string
          description: The value of `tax`.
          examples:
            - '0.00'
        total:
          type: string
          description: The value of `total`.
          examples:
            - '12.00'
        currency:
          type:
            - string
            - 'null'
          description: The three-letter currency code used for monetary amounts.
          examples:
            - USD
        payment_method:
          type:
            - string
            - 'null'
          description: The value of `payment_method`.
          examples:
            - Paddle
        url:
          type:
            - string
            - 'null'
          description: The complete URL.
          examples:
            - https://clients.advinservers.com/viewinvoice.php?id=18342
        balance:
          type: string
          description: What is still owed.
        items:
          description: The value of `items`.
          anyOf:
            - type: array
              items:
                $ref: '#/components/schemas/InvoiceItemData'
            - {}
        transactions:
          description: The value of `transactions`.
          anyOf:
            - type: array
              items:
                $ref: '#/components/schemas/InvoiceTransactionData'
            - {}
        tax_rate:
          type:
            - string
            - 'null'
          description: >-
            The two levels apart, so a viewer can show "GST 5%" and "PST 7%" as
            their own lines rather than labelling their sum with the first of
            the two rates.
        tax_rate_2:
          type:
            - string
            - 'null'
          description: The value of `tax_rate_2`.
        tax_amount:
          type: string
          description: The value of `tax_amount`.
        tax_amount_2:
          type: string
          description: The value of `tax_amount_2`.
        pay_to:
          description: >-
            Who the invoice is payable to, or null where the operator has none
            of it on file.
          anyOf:
            - $ref: '#/components/schemas/InvoicePartyData'
            - type: 'null'
        billed_to:
          description: >-
            Who the invoice was raised for, or null where the billing record
            could not be read.
          anyOf:
            - $ref: '#/components/schemas/InvoicePartyData'
            - type: 'null'
      required:
        - id
        - number
        - status
        - date
        - due_date
        - date_paid
        - subtotal
        - credit
        - tax
        - total
        - currency
        - payment_method
        - url
      title: InvoiceData
    InvoiceItemData:
      type: object
      description: One line on an invoice.
      examples:
        - id: 24815
          description: >-
            Standard 4 GB - lambda-core.blackmesa.example.com (10/02/2026 -
            11/01/2026)
          amount: '12.00'
          taxed: false
      properties:
        id:
          type: integer
          description: The id ID.
          examples:
            - 24815
        description:
          type: string
          description: An optional description shown to customers.
          examples:
            - >-
              Standard 4 GB - lambda-core.blackmesa.example.com (10/02/2026 -
              11/01/2026)
        amount:
          type: string
          description: A decimal string in the invoice's currency, never a JSON number.
          examples:
            - '12.00'
        taxed:
          type: boolean
          description: The value of `taxed`.
          examples:
            - false
      required:
        - id
        - description
        - amount
        - taxed
      title: InvoiceItemData
    InvoiceTransactionData:
      type: object
      description: One payment recorded against an invoice.
      examples:
        - id: 11482
          date: '2026-09-02T19:15:08+00:00'
          gateway: paddle
          description: Invoice Payment
          amount: '12.00'
          fees: '1.10'
          reference: txn_01m1hrqsk0nna0mws23exscgkh
      properties:
        id:
          type: integer
          description: The id ID.
          examples:
            - 11482
        date:
          type:
            - string
            - 'null'
          description: The date and time for date, in UTC.
          examples:
            - '2026-09-02T19:15:08+00:00'
        gateway:
          type:
            - string
            - 'null'
          description: The gateway address for the network.
          examples:
            - paddle
        description:
          type:
            - string
            - 'null'
          description: An optional description shown to customers.
          examples:
            - Invoice Payment
        amount:
          type: string
          description: What came in. A decimal string in the invoice's currency.
          examples:
            - '12.00'
        fees:
          type: string
          description: The value of `fees`.
          examples:
            - '1.10'
        reference:
          type:
            - string
            - 'null'
          description: The provider's own reference, which is what support quotes back.
          examples:
            - txn_01m1hrqsk0nna0mws23exscgkh
      required:
        - id
        - date
        - gateway
        - description
        - amount
        - fees
        - reference
      title: InvoiceTransactionData
    InvoicePartyData:
      type: object
      description: >-
        One of the two names on an invoice: who it is payable to, and who it was
        raised for.
      examples:
        - name: Gordon Freeman
          email: gordon.freeman@blackmesa.example.com
          address_lines:
            - Black Mesa Research Facility
            - 1 Mesa Road
            - Sector C, Anomalous Materials Laboratory
            - Socorro, New Mexico 87801
            - United States
      properties:
        name:
          type:
            - string
            - 'null'
          description: 'The party''s name: a person''s, or a company''s.'
          examples:
            - Gordon Freeman
        email:
          type:
            - string
            - 'null'
          description: Where the party is reachable, or null where no address is on file.
          examples:
            - gordon.freeman@blackmesa.example.com
        address_lines:
          type: array
          description: The postal address, one line at a time, in the order it is read.
          examples:
            - - Black Mesa Research Facility
              - 1 Mesa Road
              - Sector C, Anomalous Materials Laboratory
              - Socorro, New Mexico 87801
              - United States
          items:
            type: string
      required:
        - name
        - email
        - address_lines
      title: InvoicePartyData
  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.