UseCreditsResult

UseCreditsResult = object

Defined in: src/react/useCredits.ts:35 

Properties

balance

balance: HandlersCreditBalanceResponse | null

Defined in: src/react/useCredits.ts:39 

Current credit balance and related info

error

error: Error | null

Defined in: src/react/useCredits.ts:51 

Error from the last operation

fetchPacks()

fetchPacks: () => Promise<void>

Defined in: src/react/useCredits.ts:59 

Fetch available credit packs

Returns

Promise<void>

isLoading

isLoading: boolean

Defined in: src/react/useCredits.ts:47 

Whether any operation is in progress

packs

packs: HandlersCreditPack[]

Defined in: src/react/useCredits.ts:43 

Available credit packs for purchase

purchaseCredits()

purchaseCredits: (credits: number, options?: object) => Promise<string | null>

Defined in: src/react/useCredits.ts:65 

Create a Stripe checkout session for purchasing a credit pack

Parameters

Returns

Promise<string | null>

The checkout URL or null on error

refetch()

refetch: () => Promise<void>

Defined in: src/react/useCredits.ts:55 

Refetch the credit balance

Returns

Promise<void>