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

# List invoices

> Retrieve your invoices, newest first, as a cursor-paginated list. Pass `next_cursor` as `cursor` to fetch the next page while `has_more` is true.

Requires the `account:read` scope.



## OpenAPI

````yaml api/openapi.json GET /v1/account/invoices
openapi: 3.1.0
info:
  title: SOAX API
  version: v1
  description: >-
    Programmatic access to your SOAX account: manage proxy packages, generate
    connection strings, browse available locations, pull usage analytics, and
    manage API keys. All endpoints are served over HTTPS and return JSON.
servers:
  - url: https://api.platform.soax.com
security:
  - bearerAuth: []
tags:
  - name: API Keys
    description: >-
      Self-service management of the API keys used to authenticate with this
      API.
  - name: Packages
    description: >-
      Read proxy packages, build proxy connection strings, and rotate package
      passwords.
  - name: Stateful Sessions
    description: Create and manage long-lived, server-configured proxy sessions.
  - name: Locations
    description: >-
      Location reference data: tiers, countries, regions, cities, ISPs, ASNs,
      and ZIP codes.
  - name: Account
    description: Read-only account, credit, and subscription information.
  - name: Analytics
    description: Usage analytics for your proxy packages.
paths:
  /v1/account/invoices:
    get:
      tags:
        - Account
      summary: List invoices
      description: >-
        Retrieve your invoices, newest first, as a cursor-paginated list. Pass
        `next_cursor` as `cursor` to fetch the next page while `has_more` is
        true.


        Requires the `account:read` scope.
      operationId: list_account_invoices_v1_account_invoices_get
      parameters:
        - name: status
          in: query
          required: false
          schema:
            type: string
            enum:
              - issued
              - paid
              - unpaid
              - void
          description: Only invoices with this status.
        - name: invoice_date_from
          in: query
          required: false
          schema:
            type: string
            format: date
          description: Earliest invoice date, inclusive (`YYYY-MM-DD`).
        - name: invoice_date_to
          in: query
          required: false
          schema:
            type: string
            format: date
          description: Latest invoice date, inclusive (`YYYY-MM-DD`).
        - name: cursor
          in: query
          required: false
          schema:
            type: string
          description: '`next_cursor` from the previous page.'
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 20
          description: Invoices per page (1-100).
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvoiceListResponse'
              example:
                data:
                  - id: inv_01J8Z3K4M5N6P7Q8R9S0T1U2V3
                    number: SOAX-2026-000123
                    total: 99
                    subtotal: 90
                    tax_amount: 9
                    amount_due: 0
                    invoice_date: '2026-08-02T00:00:00Z'
                    due_date: '2026-08-16T00:00:00Z'
                    status: paid
                    pdf_available: true
                has_more: true
                next_cursor: eyJpIjoiaW52XzAxSjhaM0s0TTVONiJ9
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/ForbiddenScope'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
        '429':
          $ref: '#/components/responses/RateLimited'
components:
  schemas:
    InvoiceListResponse:
      properties:
        data:
          items:
            $ref: '#/components/schemas/InvoiceResponse'
          type: array
          title: Data
        has_more:
          type: boolean
          title: Has More
          description: Whether more invoices follow this page.
        next_cursor:
          anyOf:
            - type: string
            - type: 'null'
          title: Next Cursor
          description: Pass as `cursor` to fetch the next page.
      type: object
      required:
        - data
        - has_more
      title: InvoiceListResponse
      description: A cursor-paginated list of invoices.
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    InvoiceResponse:
      properties:
        id:
          type: string
          title: Id
          description: Invoice ID. Use it with the download endpoint.
        number:
          anyOf:
            - type: string
            - type: 'null'
          title: Number
          description: Human-readable invoice number.
        total:
          type: number
          title: Total
          description: Invoice total, tax included.
        subtotal:
          anyOf:
            - type: number
            - type: 'null'
          title: Subtotal
        tax_amount:
          anyOf:
            - type: number
            - type: 'null'
          title: Tax Amount
        amount_due:
          anyOf:
            - type: number
            - type: 'null'
          title: Amount Due
        invoice_date:
          type: string
          format: date-time
          title: Invoice Date
        due_date:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Due Date
        status:
          type: string
          enum:
            - issued
            - paid
            - unpaid
            - void
          title: Status
          description: '`unpaid` means issued and past its due date.'
        pdf_available:
          type: boolean
          title: Pdf Available
          description: Whether the invoice PDF can be downloaded.
      type: object
      required:
        - id
        - total
        - invoice_date
        - status
        - pdf_available
      title: InvoiceResponse
      description: Public response model for a single invoice. Drafts are never exposed.
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  responses:
    Unauthorized:
      description: Missing, invalid, or revoked API key.
      content:
        application/json:
          schema:
            type: object
            properties:
              detail:
                type: string
          example:
            detail: Invalid API key
    ForbiddenScope:
      description: The API key does not carry the scope this endpoint requires.
      content:
        application/json:
          schema:
            type: object
            properties:
              detail:
                type: string
          example:
            detail: 'Missing required scope: proxy:packages:read'
    RateLimited:
      description: >-
        Rate limit exceeded (5 requests/second per API key, 500 requests/minute
        per IP). The response includes `Retry-After` (seconds),
        `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` (Unix
        time) headers — wait `Retry-After` seconds and retry.
      content:
        application/json:
          schema:
            type: object
            properties:
              error:
                type: string
          example:
            error: 'Rate limit exceeded: 5 per 1 second'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        API key secret (starts with `s_live_`). Create keys in the dashboard
        under [**Settings → API
        keys**](https://platform.soax.com/settings/api-keys), or via `POST
        /v1/api-keys/`. Send it as `Authorization: Bearer <secret>`.

````

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