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 →
Get credit note totals
GET
/v1/credit-notes/stats
const url = 'http://localhost:8080/v1/credit-notes/stats';const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url http://localhost:8080/v1/credit-notes/stats \ --header 'Authorization: Bearer <token>'Counts of every credit note by status, and the money on issued notes, one entry per currency. Covers every note in this mode, not a page of them. Draft and voided notes are counted but move no money.
Authorizations
Section titled “Authorizations”Responses
Section titled “Responses”Credit note totals.
Media typeapplication/json
object
draft_count
required
integer
issued_count
required
integer
voided_count
required
integer
by_currency
required
Money on issued notes, one entry per currency, the tenant’s default currency first. Empty when no note is issued.
Array<object>
object
currency
required
string
total_cents
required
Total of the issued notes.
integer format: int64
refunded_cents
required
Refunds that succeeded. A refund still pending or one that failed is not counted here.
integer format: int64
refund_pending_cents
required
Refunds not confirmed yet. Neither succeeded nor failed, the refund is waiting on Stripe, Stripe’s answer was unclear, or its result was never recorded.
integer format: int64
refund_failed_cents
required
Refunds that failed. No money went back to the card.
integer format: int64
credited_cents
required
Added to customers’ credit balances.
integer format: int64
out_of_band_cents
required
Recorded as paid back outside Stripe.
integer format: int64
Example generated
{ "draft_count": 1, "issued_count": 1, "voided_count": 1, "by_currency": [ { "currency": "example", "total_cents": 1, "refunded_cents": 1, "refund_pending_cents": 1, "refund_failed_cents": 1, "credited_cents": 1, "out_of_band_cents": 1 } ]}