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

# List ledger entries

> List every movement of the balance, newest first: charges for browser time, premium traffic and captcha solves, top-ups, refunds, vouchers, plan credit and manual adjustments. A charge is a negative amount. Filter by type, direction and since.



## OpenAPI

````yaml /api-reference/openapi.json get /billing/ledger
openapi: 3.1.0
info:
  title: Surfsky API
  version: 0.1.0
  description: >-
    Start cloud browsers, control them through CDP, and manage the profiles,
    proxies, and fingerprints they run with.
servers:
  - url: '{baseUrl}'
    variables:
      baseUrl:
        default: https://YOUR_API_HOST
        description: API base URL from your Surfsky dashboard, including https://.
security:
  - ApiToken: []
tags:
  - name: scrape
    description: >-
      Fetch one page through a browser that is already running: a residential
      proxy and a desktop fingerprint, nothing kept between requests.
  - name: profiles
    description: >-
      Start, stop, and manage browsers. A one-time profile is discarded when it
      stops; a persistent profile keeps its cookies, storage, and fingerprint
      according to its storage settings.
  - name: proxies
    description: >-
      Look up available proxy locations and check traffic quotas for the premium
      and shared pools.
  - name: fingerprints
    description: >-
      Look up accepted renderer, screen, and device model values before
      configuring a fingerprint.
  - name: extensions
    description: Upload Chrome extensions once and load them into any browser you start.
  - name: billing
    description: >-
      Read the balance, the receipt of every session and scrape, usage over time
      windows and the ledger of charges and top-ups.
  - name: site-reports
    description: Tell the Surfsky team about a website that keeps blocking your browsers.
paths:
  /billing/ledger:
    get:
      tags:
        - billing
      summary: List ledger entries
      description: >-
        List every movement of the balance, newest first: charges for browser
        time, premium traffic and captcha solves, top-ups, refunds, vouchers,
        plan credit and manual adjustments. A charge is a negative amount.
        Filter by type, direction and since.
      operationId: billing_ledger_billing_ledger_get
      parameters:
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            maximum: 200
            minimum: 1
            default: 25
            title: Limit
          description: Page size.
        - name: offset
          in: query
          required: false
          schema:
            type: integer
            minimum: 0
            default: 0
            title: Offset
          description: Entries to skip.
        - name: type
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: Type
          description: Comma-separated entry types, such as session_charge,traffic_charge.
        - name: direction
          in: query
          required: false
          schema:
            anyOf:
              - type: string
                pattern: ^(in|out)$
              - type: 'null'
            title: Direction
          description: in for money added, out for charges.
        - name: since
          in: query
          required: false
          schema:
            anyOf:
              - type: integer
                maximum: 2147483647
                minimum: 0
              - type: 'null'
            title: Since
          description: Unix timestamp in seconds; nothing older is returned.
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Ledger'
        '401':
          description: Missing or invalid API token
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '403':
          description: Account or feature access denied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '422':
          description: Request validation failed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
components:
  schemas:
    Ledger:
      type: object
      properties:
        success:
          type: boolean
        msg:
          type: string
        data:
          type: object
          properties:
            entries:
              type: array
              description: Newest first.
              items:
                type: object
                properties:
                  created_at:
                    type: integer
                    description: Unix timestamp in seconds.
                  amount:
                    type: string
                    description: Negative for a charge.
                  balance_type:
                    type: string
                    enum:
                      - plan
                      - voucher
                      - purchased
                    description: The balance the amount moved.
                  type:
                    type: string
                    enum:
                      - session_charge
                      - traffic_charge
                      - captcha_charge
                      - topup
                      - auto_topup
                      - refund
                      - voucher
                      - voucher_expiry
                      - plan_credit_grant
                      - plan_credit_applied
                      - plan_credit_expiry
                      - adjustment
                    description: >-
                      session_charge, traffic_charge and captcha_charge are what
                      browser time, premium traffic and captcha solves cost; the
                      rest are top-ups, refunds, vouchers, plan credit and
                      manual adjustments.
                  reason:
                    type:
                      - string
                      - 'null'
                    description: Note left with a manual adjustment or a voucher.
                  session_uuid:
                    type:
                      - string
                      - 'null'
                    description: The session a charge belongs to.
                  stripe_ref:
                    type:
                      - string
                      - 'null'
                    description: Stripe payment or invoice behind a top-up or refund.
                required:
                  - created_at
                  - amount
                  - balance_type
                  - type
                  - reason
                  - session_uuid
                  - stripe_ref
            total:
              type: integer
              description: Entries matching the filters, for paging.
          required:
            - entries
            - total
      required:
        - success
        - data
    ApiError:
      type: object
      properties:
        success:
          type: boolean
          const: false
        msg:
          type: string
        code:
          type: string
        data: {}
        detail: {}
        error: {}
      description: >-
        Error fields vary for forwarded responses. Check HTTP status and code
        when present.
  securitySchemes:
    ApiToken:
      type: apiKey
      in: header
      name: X-Cloud-Api-Token
      description: API token from your dashboard.

````

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