Pre-1.0 · one maintainer · Stripe and cards only · no SDKs (client libraries) yet · no production users yet. Docs describe v0.9.1 (29 Oct 2026) · What’s new →
The credit ledger entry object
Fields
Section titled “Fields”| Field | Type | Always present | What it means |
|---|---|---|---|
id |
string | Yes | |
tenant_id |
string | No | |
customer_id |
string | Yes | |
entry_type |
enum | Yes | One of: grant, usage, expiry, adjustment. |
currency |
string | Yes | The entry’s currency, uppercase. Credit pays only invoices in its own currency. |
amount_cents |
integer (int64) | Yes | Positive adds credit, negative removes it. |
balance_after |
integer (int64) | Yes | The customer’s credit balance in this entry’s currency after it, in cents. |
description |
string | Yes | |
invoice_id |
string | No | |
expires_at |
string (date-time) | No | On a grant, its expiry. The credit can be drawn up to and including this instant; a period invoice draws it when its period ends at or before it. The dashboard sends the local midnight after the picked day. |
metadata |
object | No | |
created_at |
string (date-time) | Yes | |
consumed_cents |
integer (int64) | No | For entries that add credit, how much has been used or expired. |
grant_kind |
enum | No | One of: commit, promotional. |
source_invoice_id |
string | No | For a commit grant, the invoice that paid for it. |
source_subscription_id |
string | No | With source_subscription_item_id, source_plan_changed_at and source_change_type, set on a proration credit: the subscription change that produced it. |
source_subscription_item_id |
string | No | |
source_plan_changed_at |
string (date-time) | No | |
source_change_type |
enum | No | Classifies per-item proration artifacts so the dedup index can distinguish a plan-change and a quantity-change that happen to share the same (subscription, item, timestamp). One of: plan, quantity, add, remove. |
source_credit_note_id |
string | No | The credit note that granted this credit to the balance. |
source_invoice_reversal_id |
string | No | The voided invoice whose applied credit this entry gave back. |