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

# List an account's credit ledger

> Lists the entries of an account's credit ledger, newest first. This is also how an account's usage is
read: every operation that spends credits is a `debit` entry, so summing the `debit` entries over a
period gives the credits consumed in it, and the other types give what was added.

An account reads its own ledger; with a partner's API key, that is the account of the person who
administers the partner. Widgetic administrators can read any account's. `getPartnerCreditTransactions`
reads this same ledger by partner id.

The page is always bounded: `limit` defaults to 100 and is capped at 500, `offset` defaults to 0.




## OpenAPI

````yaml /openapi/widgetic-api-public.json get /credits/user/{userId}/transactions
openapi: 3.0.0
info:
  title: Widgetic API Gateway
  version: 1.0.0
  description: API documentation for the Widgetic API Gateway
  license:
    name: Widgetic Integration License
    url: https://docs.widgetic.com/resources/license
servers:
  - url: https://api.widgetic.com/v1
    description: Production server
    variables:
      env:
        default: production
        description: Environment
      apiUrl:
        default: https://api.widgetic.com
        description: API URL
      apiVersion:
        default: /v1
        description: API Version path prefix
security: []
tags: []
paths:
  /credits/user/{userId}/transactions:
    get:
      tags:
        - Credits
      summary: List an account's credit ledger
      description: >
        Lists the entries of an account's credit ledger, newest first. This is
        also how an account's usage is

        read: every operation that spends credits is a `debit` entry, so summing
        the `debit` entries over a

        period gives the credits consumed in it, and the other types give what
        was added.


        An account reads its own ledger; with a partner's API key, that is the
        account of the person who

        administers the partner. Widgetic administrators can read any account's.
        `getPartnerCreditTransactions`

        reads this same ledger by partner id.


        The page is always bounded: `limit` defaults to 100 and is capped at
        500, `offset` defaults to 0.
      operationId: getUserCreditTransactions
      parameters:
        - in: path
          name: userId
          required: true
          schema:
            type: string
            format: uuid
          description: The account whose ledger to read
        - in: query
          name: transactionType
          schema:
            type: string
          description: >
            Only entries of this type, for instance `debit` for the credits
            spent. The types are listed on `AccountCreditTransaction`.
        - in: query
          name: limit
          schema:
            type: integer
            minimum: 1
            maximum: 500
            default: 100
          description: Maximum number of entries to return
        - in: query
          name: offset
          schema:
            type: integer
            minimum: 0
            default: 0
          description: Number of entries to skip
      responses:
        '200':
          description: The account's ledger entries, newest first
          content:
            application/json:
              schema:
                title: AccountCreditTransactionListResponse
                type: object
                properties:
                  success:
                    type: boolean
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/AccountCreditTransaction'
                  meta:
                    $ref: '#/components/schemas/ResponseMeta'
                required:
                  - success
                  - data
        '401':
          description: The API key is missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: The ledger belongs to another account
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - apiKeyAuth: []
components:
  schemas:
    AccountCreditTransaction:
      type: object
      description: One entry of an account's credit ledger.
      properties:
        id:
          type: string
          format: uuid
        transactionType:
          type: string
          nullable: true
          description: >
            What the entry did to the balance. `debit` is credits spent (this is
            how consumption shows), `credit` and `subscription` are credits
            added, `refund` returns credits that were spent, `reserve` and
            `release` move credits in and out of the reserved amount, and
            `adjustment`, `expiration`, `transfer_out` and `transfer_in` are the
            remaining ways a balance changes. The list can grow, so treat an
            unknown type as an entry you do not need to interpret.
        amount:
          type: number
          description: >-
            Always positive. The `transactionType` says whether the credits were
            added or taken.
        balanceAfter:
          type: number
          nullable: true
          description: The balance once this entry was applied
        description:
          type: string
          nullable: true
        referenceId:
          type: string
          nullable: true
          description: >-
            The event the entry belongs to. An entry is recorded once per
            reference.
        createdAt:
          type: string
          format: date-time
      example:
        id: 3fa85f64-5717-4562-b3fc-2c963f66afa6
        transactionType: Example transactionType
        amount: 42
        balanceAfter: 42
        description: Example description
        referenceId: Example referenceId
        createdAt: '2026-01-15T09:30:00.000Z'
    ResponseMeta:
      type: object
      description: >-
        Extra information about the answer: where a page sits in a list, the
        cursor of the next page, or warnings about a call that succeeded with a
        caveat.
      additionalProperties: true
      properties:
        page:
          type: integer
          description: The page that was read, counting from 1.
          example: 1
        size:
          type: integer
          description: How many items one page holds.
          example: 20
        total:
          type: integer
          description: How many items the whole list has.
          example: 135
        limit:
          type: integer
          description: The same as `size`.
          example: 20
        offset:
          type: integer
          description: How many items come before this page.
          example: 0
        hasNextPage:
          type: boolean
          example: true
        hasPreviousPage:
          type: boolean
          example: false
        nextCursor:
          type: string
          nullable: true
          description: >-
            Pass this as `cursor` to read the next page of a list that is read
            by cursor. `null` on the last page.
        warnings:
          type: array
          items:
            type: string
          description: >-
            Things the call did not do, though it succeeded (for example a table
            that could not be created just now).
    ErrorResponse:
      type: object
      required:
        - success
        - message
        - error
      additionalProperties: true
      properties:
        success:
          type: boolean
          description: Always `false` on a failure.
          example: false
        message:
          type: string
          description: The same text as `error.message`, for a caller that reads one line.
        error:
          $ref: '#/components/schemas/ErrorDetail'
    ErrorDetail:
      type: object
      required:
        - code
        - message
        - timestamp
      properties:
        code:
          type: string
          description: Machine-readable error code.
          example: RESOURCE_NOT_FOUND
        message:
          type: string
          description: Human-readable explanation.
          example: Composition not found
        param:
          type: string
          description: The field that caused the error, when one did.
          example: name
        docUrl:
          type: string
          description: Where this error is explained.
        suggestedAction:
          type: string
          description: What to do about it.
        retryAfter:
          type: integer
          description: >-
            Seconds to wait before trying again (rate limits). The same number
            is in the `Retry-After` header.
          example: 60
        details:
          type: object
          additionalProperties: true
          description: >-
            More about the error: the fields that failed, a limit that was
            reached.
        correlationId:
          type: string
          description: Quote this when you ask support about the call.
          example: req_123e4567-e89b-12d3-a456-426614174000
        timestamp:
          type: string
          format: date-time
          example: '2026-10-15T10:00:00.000Z'
  securitySchemes:
    apiKeyAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````

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