---
title: "List settlements"
url: "https://real-estate-agency.apim.eu/apis/chargeback-settlement/versions/109ed889-6e58-4a7d-be59-d2717eab4852/operations/listSettlements"
---

> Full API specification: https://real-estate-agency.apim.eu/apis/chargeback-settlement/versions/109ed889-6e58-4a7d-be59-d2717eab4852.md

# List settlements

`GET` `/settlements`

Operation ID: `listSettlements`

## Query parameters

- `status` (string, optional)
- `agent_id` (string, optional)
- `period_from` (string, date, optional)
- `period_to` (string, date, optional)

## Responses

- `200` - Results list
- `401` - Key is missing, revoked or invalid
- `429` - Rate limit reached

## OpenAPI definition

```yaml
openapi: 3.0.3
info:
  title: Usage Chargeback & Settlement
  version: 1.0.0
servers:
  - url: https://api.nexora.example/v1
    description: Production
  - url: https://sandbox.api.nexora.example/v1
    description: Sandbox
paths:
  /settlements:
    get:
      tags:
        - Settlements
      summary: List settlements
      operationId: listSettlements
      parameters:
        - name: status
          in: query
          schema:
            $ref: "#/components/schemas/SettlementStatus"
        - name: agent_id
          in: query
          schema:
            type: string
            example: agt_8f2c1a
        - name: period_from
          in: query
          schema:
            type: string
            format: date
        - name: period_to
          in: query
          schema:
            type: string
            format: date
      responses:
        "200":
          description: Results list
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: "#/components/schemas/Settlement"
                  page:
                    $ref: "#/components/schemas/Page"
        "401":
          $ref: "#/components/responses/NotAuthenticated"
        "429":
          $ref: "#/components/responses/TooManyRequests"
security:
  - apiKey: []
components:
  schemas:
    SettlementStatus:
      type: string
      enum:
        - draft
        - open
        - partially_paid
        - paid
        - canceled
      example: open
    Settlement:
      type: object
      properties:
        id:
          type: string
          example: stl_7c53
        agent_id:
          type: string
          example: agt_8f2c1a
        status:
          $ref: "#/components/schemas/SettlementStatus"
        usage_type:
          $ref: "#/components/schemas/UsageType"
        billing_basis_usd:
          type: number
          format: float
          example: 6380
        line_items:
          type: array
          items:
            $ref: "#/components/schemas/LineItem"
        invoice_id:
          type: string
          example: inv_a920
        due_date:
          type: string
          format: date
          example: 2026-09-14
        paid_usd:
          type: number
          format: float
          example: 0
        created_at:
          type: string
          format: date-time
          example: 2026-08-15T07:30:00Z
    Page:
      type: object
      description: Cursor-based pagination.
      properties:
        count:
          type: integer
          example: 25
        total:
          type: integer
          example: 138
        next_cursor:
          type: string
          nullable: true
          example: eyJzIjoyNX0
    UsageType:
      type: string
      enum:
        - standard
        - burst
        - reserved
      example: standard
    LineItem:
      type: object
      properties:
        payer:
          type: string
          enum:
            - consuming_team
            - platform_subsidy
            - partner_cost_center
            - shared_services
        rate_percent:
          type: number
          format: float
          example: 12
        net_usd:
          type: number
          format: float
          example: 765.6
        overhead_usd:
          type: number
          format: float
          example: 61.25
        total_usd:
          type: number
          format: float
          example: 826.85
    Error:
      type: object
      description: Uniform error format across all Nexora AI APIs.
      required:
        - code
        - message
      properties:
        code:
          type: string
          example: validation_failed
        message:
          type: string
          example: The billing basis is required to calculate the chargeback.
        details:
          type: array
          items:
            $ref: "#/components/schemas/ErrorDetail"
    ErrorDetail:
      type: object
      properties:
        field:
          type: string
          example: chargeback_rate_percent
        reason:
          type: string
          example: missing
  responses:
    NotAuthenticated:
      description: Key is missing, revoked or invalid
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/Error"
    TooManyRequests:
      description: Rate limit reached
      headers:
        Retry-After:
          schema:
            type: integer
            example: 12
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/Error"
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: apikey
      description: |
        Every call carries an API key in the `apikey` header. You generate the
        key in the Nexora AI portal under "My Apps"; it's shown exactly once.

        Each key has the scopes it's allowed to use attached to it. If one is
        missing, the API responds with `403` and `code: "scope_missing"`; the
        missing scope is in `details[].field`.
```