> ## 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.

# Create Ledger Entry

> Creates a ledger entry to credit or debit a customer's balance



## OpenAPI

````yaml post /credit-entitlements/{credit_entitlement_id}/balances/{customer_id}/ledger-entries
openapi: 3.1.0
info:
  title: public
  description: ''
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0
  version: 1.105.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-entries:
    post:
      tags:
        - Credit Entitlement Balances
      summary: Creates a ledger entry to credit or debit a customer's balance.
      description: >-
        For credit entries, a new grant is created. For debit entries, credits
        are

        deducted from existing grants using FIFO (oldest first).


        # Authentication

        Requires an API key with `Editor` role.


        # Path Parameters

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

        - `customer_id` - The unique identifier of the customer


        # Request Body

        - `entry_type` - "credit" or "debit"

        - `amount` - Amount to credit or debit

        - `reason` - Optional human-readable reason

        - `expires_at` - Optional expiration for credited amount (only for
        credit type)

        - `idempotency_key` - Optional key to prevent duplicate entries


        # Responses

        - `201 Created` - Ledger entry created successfully

        - `400 Bad Request` - Invalid request (e.g., debit with insufficient
        balance)

        - `404 Not Found` - Credit entitlement or customer not found

        - `409 Conflict` - Idempotency key already exists

        - `500 Internal Server Error` - Database or server error
      operationId: create_ledger_entry_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
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateLedgerEntryRequest'
        required: true
      responses:
        '201':
          description: Ledger entry created successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateLedgerEntryResponse'
        '400':
          description: Invalid request or insufficient balance
        '404':
          description: Credit entitlement or customer not found
        '409':
          description: Idempotency key already exists
        '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
            });


            const response = await
            client.creditEntitlements.balances.createLedgerEntry('customer_id',
            {
              credit_entitlement_id: 'credit_entitlement_id',
              amount: 'amount',
              entry_type: 'credit',
            });


            console.log(response.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
            )
            response = client.credit_entitlements.balances.create_ledger_entry(
                customer_id="customer_id",
                credit_entitlement_id="credit_entitlement_id",
                amount="amount",
                entry_type="credit",
            )
            print(response.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\tresponse, err := client.CreditEntitlements.Balances.NewLedgerEntry(\n\t\tcontext.TODO(),\n\t\t\"credit_entitlement_id\",\n\t\t\"customer_id\",\n\t\tdodopayments.CreditEntitlementBalanceNewLedgerEntryParams{\n\t\t\tAmount:    dodopayments.F(\"amount\"),\n\t\t\tEntryType: dodopayments.F(dodopayments.LedgerEntryTypeCredit),\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", response.ID)\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.BalanceCreateLedgerEntryParams;

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

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


            public final class Main {
                private Main() {}

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

                    BalanceCreateLedgerEntryParams params = BalanceCreateLedgerEntryParams.builder()
                        .creditEntitlementId("credit_entitlement_id")
                        .customerId("customer_id")
                        .amount("amount")
                        .entryType(LedgerEntryType.CREDIT)
                        .build();
                    BalanceCreateLedgerEntryResponse response = client.creditEntitlements().balances().createLedgerEntry(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.BalanceCreateLedgerEntryParams

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

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


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

                val params: BalanceCreateLedgerEntryParams = BalanceCreateLedgerEntryParams.builder()
                    .creditEntitlementId("credit_entitlement_id")
                    .customerId("customer_id")
                    .amount("amount")
                    .entryType(LedgerEntryType.CREDIT)
                    .build()
                val response: BalanceCreateLedgerEntryResponse = client.creditEntitlements().balances().createLedgerEntry(params)
            }
        - lang: Ruby
          source: >-
            require "dodopayments"


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


            response =
            dodo_payments.credit_entitlements.balances.create_ledger_entry(
              "customer_id",
              credit_entitlement_id: "credit_entitlement_id",
              amount: "amount",
              entry_type: :credit
            )


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

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

            use Dodopayments\Client;
            use Dodopayments\Core\Exceptions\APIException;
            use Dodopayments\CreditEntitlements\Balances\LedgerEntryType;

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

            try {
              $response = $client->creditEntitlements->balances->createLedgerEntry(
                'customer_id',
                creditEntitlementID: 'credit_entitlement_id',
                amount: 'amount',
                entryType: LedgerEntryType::CREDIT,
                expiresAt: new \DateTimeImmutable('2019-12-27T18:11:19.117Z'),
                idempotencyKey: 'idempotency_key',
                metadata: ['foo' => 'string'],
                reason: 'reason',
              );

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

            using DodoPayments.Client;

            using DodoPayments.Client.Models.CreditEntitlements.Balances;


            DodoPaymentsClient client = new();


            BalanceCreateLedgerEntryParams parameters = new()

            {
                CreditEntitlementID = "credit_entitlement_id",
                CustomerID = "customer_id",
                Amount = "amount",
                EntryType = LedgerEntryType.Credit,
            };


            var response = await
            client.CreditEntitlements.Balances.CreateLedgerEntry(parameters);


            Console.WriteLine(response);
components:
  schemas:
    CreateLedgerEntryRequest:
      type: object
      description: Request to create a ledger entry (credit or debit)
      required:
        - entry_type
        - amount
      properties:
        amount:
          type: string
          description: Amount to credit or debit
        entry_type:
          $ref: '#/components/schemas/LedgerEntryType'
          description: 'Entry type: credit or debit'
        expires_at:
          type:
            - string
            - 'null'
          format: date-time
          description: Expiration for credited amount (only for credit type)
        idempotency_key:
          type:
            - string
            - 'null'
          description: Idempotency key to prevent duplicate entries
        metadata:
          oneOf:
            - type: 'null'
            - $ref: '#/components/schemas/Metadata'
              description: >-
                Optional metadata (max 50 key-value pairs, key max 40 chars,
                value max 500 chars)
        reason:
          type:
            - string
            - 'null'
          description: Human-readable reason for the entry
    CreateLedgerEntryResponse:
      type: object
      description: Response for creating a ledger entry
      required:
        - id
        - customer_id
        - credit_entitlement_id
        - entry_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
        created_at:
          type: string
          format: date-time
        credit_entitlement_id:
          type: string
        customer_id:
          type: string
        entry_type:
          $ref: '#/components/schemas/LedgerEntryType'
        grant_id:
          type:
            - string
            - 'null'
        id:
          type: string
        is_credit:
          type: boolean
        overage_after:
          type: string
        overage_before:
          type: string
        reason:
          type:
            - string
            - 'null'
    LedgerEntryType:
      type: string
      enum:
        - credit
        - debit
    Metadata:
      type: object
      additionalProperties:
        type: string
      propertyNames:
        type: string
  securitySchemes:
    API_KEY:
      type: http
      scheme: bearer

````