Credit Ledger

Retrieves the credit transaction ledger for a customer, showing all credits and debits.

Query

Query

query GetCreditLedger($input: CreditLedgerInput!) {
  creditsLedger(input: $input) {
    edges {
      node {
        id
        amount
        type
        description
        createdAt
        balanceAfter
      }
      cursor
    }
    pageInfo {
      hasNextPage
      endCursor
    }
    totalCount
  }
}

{
  "input": {
    "customerId": "customer-123",
    "paging": {
      "first": 50
    }
  }
}

{
  "data": {
    "creditsLedger": {
      "edges": [
        {
          "node": {
            "id": "ledger-001",
            "amount": 1000,
            "type": "CREDIT",
            "description": "Initial credit grant",
            "createdAt": "2024-01-01T00:00:00Z",
            "balanceAfter": 1000
          },
          "cursor": "abc123"
        },
        {
          "node": {
            "id": "ledger-002",
            "amount": -50,
            "type": "DEBIT",
            "description": "API usage: 50 calls",
            "createdAt": "2024-01-15T10:30:00Z",
            "balanceAfter": 950
          },
          "cursor": "def456"
        }
      ],
      "pageInfo": {
        "hasNextPage": true,
        "endCursor": "def456"
      },
      "totalCount": 125
    }
  }
}

Parameters

input · CreditLedgerInput · required

Input parameters for credit ledger query

Show properties

customerId · String · required

The customer’s reference ID

resourceId · String

Resource ID for multi-resource customers

paging · CursorPaging

Pagination options

environmentId · UUID

Environment ID

Return Type

Returns a CreditLedgerConnection with ledger entries.

Ledger Entry Fields

Field	Type	Description
id	UUID	Entry ID
amount	Float	Transaction amount (+/-)
type	String	CREDIT or DEBIT
description	String	Transaction description
createdAt	DateTime	Transaction time
balanceAfter	Float	Balance after transaction

Overdraft settlement event types

The credit ledger includes the following event types related to overdraft settlement:

Event Type	Description
CREDITS_CONSUMPTION_TRANSFER_SOURCE	Recorded on the overdraft grant when consumed credits are transferred out during settlement. Shows a negative quantity (reduction in consumed amount).
CREDITS_CONSUMPTION_TRANSFER_TARGET	Recorded on the new grant when consumed credits are transferred in during settlement. Shows a positive quantity (increase in consumed amount).

These events always appear in pairs — one on the source (overdraft) grant and one on the target (new) grant — with matching quantities.

Common Use Cases

Transaction history

Show detailed credit transaction history to customers.

Audit trail

Maintain audit trail of all credit movements.

Usage analysis

Analyze credit consumption patterns.

Related Operations

• Credit Balance - Current balance
• Credit Grants - List grants