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

Interface: NarevClient

Defined in: packages/narev/src/narev-client.ts:32 Typed client for the Narev billing API. Covers balance checks, top-up/credit operations, model/provider reference, pricing lookups, and cost calculation.

Methods

getBalance()

getBalance(request): Promise<BalanceResponse>
Defined in: packages/narev/src/narev-client.ts:37 Fetches the end-user’s balance and consumption for the current billing period. Pass either { userId } or { stripeCustomerId }.

Parameters

request
GetBalanceRequest

Returns

Promise<BalanceResponse>

getCreditConfig()

getCreditConfig(): Promise<CreditConfigResponse>
Defined in: packages/narev/src/narev-client.ts:40 Fetches available credit packages for top-up.

Returns

Promise<CreditConfigResponse>

createCheckout()

createCheckout(request): Promise<CheckoutResponse>
Defined in: packages/narev/src/narev-client.ts:43 Creates a checkout session for an end-user to purchase credits.

Parameters

request
CreateCheckoutRequest

Returns

Promise<CheckoutResponse>

listModels()

listModels(request?): Promise<ModelsResponse>
Defined in: packages/narev/src/narev-client.ts:46 Returns a paginated list of model references (provider_id + model_id, no pricing).

Parameters

request?
ListModelsRequest

Returns

Promise<ModelsResponse>

listProviders()

listProviders(): Promise<ProvidersResponse>
Defined in: packages/narev/src/narev-client.ts:49 Returns all supported providers with their display name.

Returns

Promise<ProvidersResponse>

listPrices()

listPrices(request?): Promise<PriceResponse>
Defined in: packages/narev/src/narev-client.ts:52 Returns a paginated list of pricing entries filtered by provider and/or model.

Parameters

request?
ListPricesRequest

Returns

Promise<PriceResponse>

searchPrices()

searchPrices(request?): Promise<PriceResponse>
Defined in: packages/narev/src/narev-client.ts:55 Searches pricing entries by model ID (full-text search via q).

Parameters

request?
SearchPricesRequest

Returns

Promise<PriceResponse>

calculateCost()

calculateCost(request): Promise<TraceCostResponse>
Defined in: packages/narev/src/narev-client.ts:58 Calculates the cost for a model call given token usage.

Parameters

request
TraceCostRequest

Returns

Promise<TraceCostResponse>