List Customer Ledger

Lists ledger entries for a customer under a specific credit entitlement

GET /credit-entitlements/{credit_entitlement_id}/balances/{customer_id}/ledger

JavaScript

JavaScript

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);
}

200

{
  "items": [
    {
      "amount": "<string>",
      "balance_after": "<string>",
      "balance_before": "<string>",
      "business_id": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "credit_entitlement_id": "<string>",
      "customer_id": "<string>",
      "id": "<string>",
      "is_credit": true,
      "overage_after": "<string>",
      "overage_before": "<string>",
      "description": "<string>",
      "grant_id": "<string>",
      "reference_id": "<string>",
      "reference_type": "<string>"
    }
  ]
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

credit_entitlement_id · string · required

Credit Entitlement ID

customer_id · string · required

Customer ID

Query Parameters

page_size · integer<int32>

Page size default is 10 max is 100

Required range: x >= 0

page_number · integer<int32>

Page number default is 0

Required range: x >= 0

transaction_type · string

Filter by transaction type (snake_case: credit_added, credit_deducted, credit_expired, etc.)

start_date · string<date-time>

Filter by start date

end_date · string<date-time>

Filter by end date

Response

200

application/json

List of ledger entries

items · object[] · required

Show child attributes