getApiV1CreditsBalance

getApiV1CreditsBalance<ThrowOnError>(options?: Options<GetApiV1CreditsBalanceData, ThrowOnError>): RequestResult<GetApiV1CreditsBalanceResponses, GetApiV1CreditsBalanceErrors, ThrowOnError>

Defined in: src/client/sdk.gen.ts:238

Get credit balance

Returns the credit balance and related information for the authenticated user. Optionally accepts X-Timezone header for accurate next claim time calculation.

Type Parameters

Type Parameter	Default type
`ThrowOnError` extends `boolean`	`false`

Parameters

Parameter	Type
`options?`	`Options`<`GetApiV1CreditsBalanceData`, `ThrowOnError`>

Returns

RequestResult<GetApiV1CreditsBalanceResponses, GetApiV1CreditsBalanceErrors, ThrowOnError>