---
title: "List credit event ledger"
method: GET
path: "/v2/billing/credits/ledger"
tags: ["credits"]
---

# List credit event ledger

`GET /v2/billing/credits/ledger`

## Query parameters

- `billing_credit_id` string
- `company_id` string, required
- `end_time` string
- `event_type` 'grant' | 'transfer' | 'usage' | 'zero_out'
- `feature_id` string
- `start_time` string
- `limit` integer — Page limit (default 100)
- `offset` integer — Page offset (default 0)

## 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, 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
    - `environment_id` string, required
    - `event_at` string, date-time, required
    - `event_id` string, required
    - `event_type` 'grant' | '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' | 'purchased' | 'rollover'
    - `grant_valid_from` string, date-time, nullable
    - `plan_id` string, nullable
    - `quantity_consumed` number, double, nullable
    - `quantity_remaining_at_zero_out` number, double, nullable
    - `source_id` integer, required
    - `to_grant_id` string, nullable
    - `usage_event_id` string, nullable
    - `usage_reason` 'lease_hold' | 'lease_release' | 'manual_adjustment' | 'reconciliation' | 'track'
    - `zeroed_out_reason` 'customer_archived' | 'expired' | 'integration_uninstalled' | 'license_retired' | 'manual' | 'plan_change' | 'plan_period_reset' | 'reconciled'
  - `params` object, required — Input parameters
    - `billing_credit_id` string
    - `company_id` string
    - `end_time` string
    - `event_type` 'grant' | 'transfer' | 'usage' | 'zero_out'
    - `feature_id` string
    - `limit` integer — Page limit (default 100)
    - `offset` integer — Page offset (default 0)
    - `start_time` string

## Other responses

- `400` — Bad request
- `401` — Unauthorized
- `403` — Forbidden
- `404` — Not found
- `500` — Server error

---

[API](https://skmtc.net/schematichq/apis/schematic-api.md) · [All operations](https://skmtc.net/schematichq/apis/schematic-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/schematichq/schematic-api/versions/873fb318b08a/schema)