> ## 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 credit blocks

> List your active credit blocks with their initial and remaining balances and expiry dates. Credits are consumed by proxy traffic according to the tier of the country the traffic routes through.

Requires the `account:read` scope.



## OpenAPI

````yaml api/openapi.json GET /v1/account/credits
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: 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/credits:
    get:
      tags:
        - Account
      summary: Get authenticated customer's credit blocks
      description: >-
        List your active credit blocks with their initial and remaining balances
        and expiry dates. Credits are consumed by proxy traffic according to the
        tier of the country the traffic routes through.


        Requires the `account:read` scope.
      operationId: get_account_credits_v1_account_credits_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/CreditBlockResponse'
                type: array
                title: Response Get Account Credits V1 Account Credits Get
              example:
                - id: c1d2e3f4-a5b6-4c7d-8e9f-0a1b2c3d4e5f
                  initial_balance: 1000
                  balance: 412.5
                  effective_date: '2026-08-01T00:00:00Z'
                  expiry_date: '2026-09-01T00:00:00Z'
                  status: active
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/ForbiddenScope'
        '429':
          $ref: '#/components/responses/RateLimited'
components:
  schemas:
    CreditBlockResponse:
      properties:
        id:
          type: string
          title: Id
        initial_balance:
          type: number
          title: Initial Balance
        balance:
          type: number
          title: Balance
        effective_date:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Effective Date
        expiry_date:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Expiry Date
        status:
          type: string
          title: Status
      type: object
      required:
        - id
        - initial_balance
        - balance
        - status
      title: CreditBlockResponse
      description: Public response model for a single credit block.
  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**, or via `POST /v1/api-keys/`. Send it as
        `Authorization: Bearer <secret>`.

````