---
title: "Get credit event ledger entry"
method: GET
path: "/v2/billing/credits/ledger/{ledger_entry_id}"
tags: ["credits"]
---

# Get credit event ledger entry

`GET /v2/billing/credits/ledger/{ledger_entry_id}`

## Request

- Base URL: `https://api.schematichq.com`
- URL: `https://api.schematichq.com/v2/billing/credits/ledger/{ledger_entry_id}`
- Auth: API key in header `X-Schematic-Api-Key`

## Path parameters

- `ledger_entry_id` string, required

## Response `200`

OK

- object
  - `data` CreditEventLedgerResponseData, required
    - `amount` number, double, required
    - `auto_topup_log_id` string, nullable
    - `billing_credit_bundle_id` string, nullable
    - `billing_credit_id` string, nullable
    - `burn_breakdown` CreditBurnBreakdownLine[]: The part of the draw this row covers: one line per priced quantity, including the request line, summing to the row amount. Set on inference-driven draws only.
      - `credits` number, double, required
      - `key` string, required
      - `quantity` number, double, required
      - `rate` number, double, required
    - `company` CompanyLedgerResponseData
      - `id` string, required
      - `logo_url` string, nullable
      - `name` string, required
    - `company_id` string, required
    - `credit` BillingCreditLedgerResponseData
      - `description` string, nullable
      - `icon` string, nullable
      - `id` string, required
      - `name` string, required
      - `plural_name` string, nullable
      - `singular_name` string, nullable
    - `credit_name` string, required
    - `currency` 'aed' | 'afn' | 'all' | 'amd' | 'ang' | 'aoa' | 'ars' | 'aud' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bif' | 'bmd' | 'bnd' | 'bob' | 'brl' | 'bsd' | 'bwp' | 'byn' | 'bzd' | 'cad' | 'cdf' | 'chf' | 'clp' | 'cny' | 'cop' | 'crc' | 'cve' | 'czk' | 'djf' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'etb' | 'eur' | 'fjd' | 'fkp' | 'gbp' | 'gel' | 'gip' | 'gmd' | 'gnf' | 'gtq' | 'gyd' | 'hkd' | 'hnl' | 'htg' | 'huf' | 'idr' | 'ils' | 'inr' | 'isk' | 'jmd' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'krw' | 'kyd' | 'kzt' | 'lak' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mur' | 'mvr' | 'mwk' | 'mxn' | 'myr' | 'mzn' | 'nad' | 'ngn' | 'nio' | 'nok' | 'npr' | 'nzd' | 'pab' | 'pen' | 'pgk' | 'php' | 'pkr' | 'pln' | 'pyg' | 'qar' | 'ron' | 'rsd' | 'rub' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sek' | 'sgd' | 'shp' | 'sle' | 'sos' | 'srd' | 'std' | 'szl' | 'thb' | 'tjs' | 'top' | 'try' | 'ttd' | 'twd' | 'tzs' | 'uah' | 'ugx' | 'usd' | 'uyu' | 'uzs' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'xcg' | 'xof' | 'xpf' | 'yer' | 'zar' | 'zmw'
    - `environment_id` string, required
    - `event_at` string, date-time, required
    - `event_id` string, required
    - `event_ids` string[], required
    - `event_type` 'adjustment' | 'charge' | 'grant' | 'settlement' | 'transfer' | 'usage' | 'zero_out', required
    - `expiry_type` 'duration' | 'end_of_billing_period' | 'end_of_next_billing_period' | 'end_of_trial' | 'no_expiry'
    - `expiry_unit` 'billing_periods' | 'days'
    - `expiry_unit_count` integer, nullable
    - `feature` FeatureLedgerResponseData
      - `description` string, nullable
      - `icon` string, nullable
      - `id` string, required
      - `name` string, required
    - `feature_id` string, nullable
    - `from_grant_id` string, nullable
    - `grant_expires_at` string, date-time, nullable
    - `grant_id` string, nullable
    - `grant_quantity` number, double, nullable
    - `grant_quantity_remaining` number, double, nullable
    - `grant_reason` 'adjustment' | 'billing_credit_auto_topup' | 'free' | 'plan' | 'postpaid_forgiven' | 'postpaid_overdraft' | 'postpaid_settlement' | 'purchased' | 'rollover'
    - `grant_valid_from` string, date-time, nullable
    - `kind` 'adjustment' | 'charge' | 'drawdown' | 'grant' | 'settlement' | 'transfer' | 'zero_out', required
    - `plan_id` string, nullable
    - `quantity_consumed` number, double, nullable
    - `quantity_remaining_at_zero_out` number, double, nullable
    - `source_id` integer, required: Always 0. Use source_id_string.
    - `source_id_string` string, nullable
    - `source_type` 'billing_charge' | 'billing_credit_grant' | 'billing_credit_transfer' | 'billing_settlement'
    - `to_grant_id` string, nullable
    - `transfer_reason` 'overdraft_recovery' | 'postpaid_debt_moved' | 'postpaid_forgiven' | 'postpaid_paid'
    - `usage_event_id` string, nullable
    - `usage_reason` 'inference' | 'lease_hold' | 'lease_release' | 'manual_adjustment' | 'reconciliation' | 'reservation_hold' | 'reservation_release' | 'track'
    - `user_id` string, nullable
    - `zeroed_out_reason` 'customer_archived' | 'expired' | 'integration_uninstalled' | 'license_retired' | 'manual' | 'plan_change' | 'plan_period_reset' | 'reconciled'
  - `params` object, required: Input parameters

## Other responses

- `401`: Unauthorized
- `403`: Forbidden
- `404`: Not found
- `500`: Server error

## Changes

> 230 revisions in range; 1 not diffed.

- **2026-10-27** `a015c997fce5`: 3 info
  - added the optional property `data/source_id_string` to the response with the `200` status
  - added the optional property `data/source_type` to the response with the `200` status
  - response property `data/source_id` deprecated
- **2026-10-20** `0368e79bc7a9`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/schematichq/apis/schematic-api/changes/v2/billing/credits/ledger/:ledger_entry_id/get.md)

---

[API](https://skmtc.dev/schematichq/apis/schematic-api.md) - [All operations](https://skmtc.dev/schematichq/apis/schematic-api/llms.txt) - [OpenAPI document](https://skmtc.dev/schematichq/apis/schematic-api/revisions/64cb7e17c236?raw)