Skip to main content
@ai-billing/narev
@ai-billing/narev / BalanceData

Interface: BalanceData

Defined in: packages/types/dist/index.d.ts:101 End-user balance and consumption data.

Properties

unitsBalance

unitsBalance: number | null
Defined in: packages/types/dist/index.d.ts:103 Current credit balance (null if not available).

unitsConsumed

unitsConsumed: number
Defined in: packages/types/dist/index.d.ts:105 Units consumed in the current billing period.

unitsCredited

unitsCredited: number | null
Defined in: packages/types/dist/index.d.ts:107 Total units credited (null for Stripe).

unit

unit: "base" | "nanos"
Defined in: packages/types/dist/index.d.ts:109 Unit of measurement — “base” for Polar, “nanos” for Stripe.

currency

currency: string
Defined in: packages/types/dist/index.d.ts:111 Currency code (e.g. “USD”).

meterName

meterName: string
Defined in: packages/types/dist/index.d.ts:113 Display name of the meter.

found

found: boolean
Defined in: packages/types/dist/index.d.ts:115 Whether the end-user has a meter entry.