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

# List Customer Ledger

> Lists ledger entries for a customer under a specific credit entitlement



## OpenAPI

````yaml get /credit-entitlements/{credit_entitlement_id}/balances/{customer_id}/ledger
openapi: 3.1.0
info:
  title: public
  description: ''
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0
  version: 1.102.0
servers:
  - url: https://test.dodopayments.com/
    description: Test Mode Server Host
  - url: https://live.dodopayments.com/
    description: Live Mode Server Host
security: []
tags:
  - name: Products
  - name: Payments
  - name: Subscriptions
  - name: Addons
  - name: Customers
  - name: Refunds
  - name: Disputes
  - name: Events
  - name: License Keys
  - name: Entitlements
  - name: Licenses
  - name: Discounts
  - name: Meters
  - name: Credit Entitlements
  - name: Credit Entitlement Balances
  - name: Outgoing Webhooks
  - name: Checkout
  - name: Webhook Events
paths:
  /credit-entitlements/{credit_entitlement_id}/balances/{customer_id}/ledger:
    get:
      tags:
        - Credit Entitlement Balances
      summary: Lists ledger entries for a customer under a specific credit entitlement.
      description: >-
        Returns a paginated list of credit transaction history with optional
        filtering.


        # Authentication

        Requires an API key with `Viewer` role or higher.


        # Path Parameters

        - `credit_entitlement_id` - The unique identifier of the credit
        entitlement

        - `customer_id` - The unique identifier of the customer


        # Query Parameters

        - `page_size` - Number of items per page (default: 10, max: 100)

        - `page_number` - Zero-based page number (default: 0)

        - `transaction_type` - Filter by transaction type

        - `start_date` - Filter entries from this date

        - `end_date` - Filter entries until this date


        # Responses

        - `200 OK` - Returns list of ledger entries

        - `404 Not Found` - Credit entitlement not found

        - `500 Internal Server Error` - Database or server error
      operationId: list_customer_ledger_handler
      parameters:
        - name: credit_entitlement_id
          in: path
          description: Credit Entitlement ID
          required: true
          schema:
            type: string
        - name: customer_id
          in: path
          description: Customer ID
          required: true
          schema:
            type: string
        - name: page_size
          in: query
          description: Page size default is 10 max is 100
          required: false
          schema:
            type: integer
            format: int32
            minimum: 0
          style: form
        - name: page_number
          in: query
          description: Page number default is 0
          required: false
          schema:
            type: integer
            format: int32
            minimum: 0
          style: form
        - name: transaction_type
          in: query
          description: >-
            Filter by transaction type (snake_case: credit_added,
            credit_deducted, credit_expired, etc.)
          required: false
          schema:
            type: string
          style: form
        - name: start_date
          in: query
          description: Filter by start date
          required: false
          schema:
            type: string
            format: date-time
          style: form
        - name: end_date
          in: query
          description: Filter by end date
          required: false
          schema:
            type: string
            format: date-time
          style: form
      responses:
        '200':
          description: List of ledger entries
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListLedgerResponse'
        '404':
          description: Credit entitlement not found
        '500':
          description: Something went wrong :(
      security:
        - API_KEY: []
      x-codeSamples:
        - lang: JavaScript
          source: >-
            import DodoPayments from 'dodopayments';


            const client = new DodoPayments({
              bearerToken: process.env['DODO_PAYMENTS_API_KEY'], // This is the default and can be omitted
            });


            // Automatically fetches more pages as needed.

            for await (const creditLedgerEntry of
            client.creditEntitlements.balances.listLedger('customer_id', {
              credit_entitlement_id: 'credit_entitlement_id',
            })) {
              console.log(creditLedgerEntry.id);
            }
        - lang: Python
          source: |-
            import os
            from dodopayments import DodoPayments

            client = DodoPayments(
                bearer_token=os.environ.get("DODO_PAYMENTS_API_KEY"),  # This is the default and can be omitted
            )
            page = client.credit_entitlements.balances.list_ledger(
                customer_id="customer_id",
                credit_entitlement_id="credit_entitlement_id",
            )
            page = page.items[0]
            print(page.id)
        - lang: Go
          source: "package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/dodopayments/dodopayments-go\"\n\t\"github.com/dodopayments/dodopayments-go/option\"\n)\n\nfunc main() {\n\tclient := dodopayments.NewClient(\n\t\toption.WithBearerToken(\"My Bearer Token\"),\n\t)\n\tpage, err := client.CreditEntitlements.Balances.ListLedger(\n\t\tcontext.TODO(),\n\t\t\"credit_entitlement_id\",\n\t\t\"customer_id\",\n\t\tdodopayments.CreditEntitlementBalanceListLedgerParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", page)\n}\n"
        - lang: Java
          source: >-
            package com.dodopayments.api.example;


            import com.dodopayments.api.client.DodoPaymentsClient;

            import com.dodopayments.api.client.okhttp.DodoPaymentsOkHttpClient;

            import
            com.dodopayments.api.models.creditentitlements.balances.BalanceListLedgerPage;

            import
            com.dodopayments.api.models.creditentitlements.balances.BalanceListLedgerParams;


            public final class Main {
                private Main() {}

                public static void main(String[] args) {
                    DodoPaymentsClient client = DodoPaymentsOkHttpClient.fromEnv();

                    BalanceListLedgerParams params = BalanceListLedgerParams.builder()
                        .creditEntitlementId("credit_entitlement_id")
                        .customerId("customer_id")
                        .build();
                    BalanceListLedgerPage page = client.creditEntitlements().balances().listLedger(params);
                }
            }
        - lang: Kotlin
          source: >-
            package com.dodopayments.api.example


            import com.dodopayments.api.client.DodoPaymentsClient

            import com.dodopayments.api.client.okhttp.DodoPaymentsOkHttpClient

            import
            com.dodopayments.api.models.creditentitlements.balances.BalanceListLedgerPage

            import
            com.dodopayments.api.models.creditentitlements.balances.BalanceListLedgerParams


            fun main() {
                val client: DodoPaymentsClient = DodoPaymentsOkHttpClient.fromEnv()

                val params: BalanceListLedgerParams = BalanceListLedgerParams.builder()
                    .creditEntitlementId("credit_entitlement_id")
                    .customerId("customer_id")
                    .build()
                val page: BalanceListLedgerPage = client.creditEntitlements().balances().listLedger(params)
            }
        - lang: Ruby
          source: |-
            require "dodopayments"

            dodo_payments = Dodopayments::Client.new(
              bearer_token: "My Bearer Token",
              environment: "test_mode" # defaults to "live_mode"
            )

            page = dodo_payments.credit_entitlements.balances.list_ledger(
              "customer_id",
              credit_entitlement_id: "credit_entitlement_id"
            )

            puts(page)
        - lang: PHP
          source: |-
            <?php

            require_once dirname(__DIR__) . '/vendor/autoload.php';

            use Dodopayments\Client;
            use Dodopayments\Core\Exceptions\APIException;

            $client = new Client(
              bearerToken: getenv('DODO_PAYMENTS_API_KEY') ?: 'My Bearer Token',
              environment: 'test_mode',
            );

            try {
              $page = $client->creditEntitlements->balances->listLedger(
                'customer_id',
                creditEntitlementID: 'credit_entitlement_id',
                endDate: new \DateTimeImmutable('2019-12-27T18:11:19.117Z'),
                pageNumber: 0,
                pageSize: 0,
                startDate: new \DateTimeImmutable('2019-12-27T18:11:19.117Z'),
                transactionType: 'transaction_type',
              );

              var_dump($page);
            } catch (APIException $e) {
              echo $e->getMessage();
            }
        - lang: C#
          source: >-
            using System;

            using DodoPayments.Client;

            using DodoPayments.Client.Models.CreditEntitlements.Balances;


            DodoPaymentsClient client = new();


            BalanceListLedgerParams parameters = new()

            {
                CreditEntitlementID = "credit_entitlement_id",
                CustomerID = "customer_id",
            };


            var page = await
            client.CreditEntitlements.Balances.ListLedger(parameters);

            await foreach (var item in page.Paginate())

            {
                Console.WriteLine(item);
            }
components:
  schemas:
    ListLedgerResponse:
      type: object
      required:
        - items
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/CreditLedgerEntryResponse'
    CreditLedgerEntryResponse:
      type: object
      description: Response for a ledger entry
      required:
        - id
        - business_id
        - customer_id
        - credit_entitlement_id
        - transaction_type
        - amount
        - is_credit
        - balance_before
        - balance_after
        - overage_before
        - overage_after
        - created_at
      properties:
        amount:
          type: string
        balance_after:
          type: string
        balance_before:
          type: string
        business_id:
          type: string
        created_at:
          type: string
          format: date-time
        credit_entitlement_id:
          type: string
        customer_id:
          type: string
        description:
          type:
            - string
            - 'null'
        grant_id:
          type:
            - string
            - 'null'
        id:
          type: string
        is_credit:
          type: boolean
        overage_after:
          type: string
        overage_before:
          type: string
        reference_id:
          type:
            - string
            - 'null'
        reference_type:
          type:
            - string
            - 'null'
        transaction_type:
          $ref: '#/components/schemas/CbbLedgerTransactionType'
    CbbLedgerTransactionType:
      type: string
      enum:
        - credit_added
        - credit_deducted
        - credit_expired
        - credit_rolled_over
        - rollover_forfeited
        - overage_charged
        - overage_reset
        - auto_top_up
        - manual_adjustment
        - refund
  securitySchemes:
    API_KEY:
      type: http
      scheme: bearer

````