> ## Documentation Index > Fetch the complete documentation index at: https://docs.flexprice.io/llms.txt > Use this file to discover all available pages before exploring further. # Get wallet balance > Use when displaying or checking current wallet balance (e.g. before charging or in a portal). Supports optional expand for credits breakdown and from_cache. ## OpenAPI ````yaml /api-reference/openapi.json get /wallets/{id}/balance/real-time openapi: 3.0.1 info: title: Flexprice API description: Flexprice API Service contact: name: API Support license: name: AGPL-3.0 url: https://www.gnu.org/licenses/agpl-3.0.html version: '1.0' servers: - url: https://us.api.flexprice.io/v1 description: US Region - url: https://api.cloud.flexprice.io/v1 description: India Region security: [] paths: /wallets/{id}/balance/real-time: get: tags: - Wallets summary: Get wallet balance description: >- Use when displaying or checking current wallet balance (e.g. before charging or in a portal). Supports optional expand for credits breakdown and from_cache. operationId: getWalletBalance parameters: - name: id in: path description: Wallet ID required: true schema: type: string - name: expand in: query description: Expand fields (e.g., credits_available_breakdown) schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/WalletBalanceResponse' '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/errors.ErrorResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/errors.ErrorResponse' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/errors.ErrorResponse' security: - ApiKeyAuth: [] components: schemas: WalletBalanceResponse: type: object properties: alert_settings: $ref: '#/components/schemas/types.AlertSettings' alert_state: $ref: '#/components/schemas/types.AlertState' auto_topup: $ref: '#/components/schemas/types.AutoTopup' balance: type: string balance_updated_at: type: string format: date-time config: $ref: '#/components/schemas/types.WalletConfig' conversion_rate: type: string description: |- amount in the currency = number of credits * conversion_rate ex if conversion_rate is 1, then 1 USD = 1 credit ex if conversion_rate is 2, then 1 USD = 0.5 credits ex if conversion_rate is 0.5, then 1 USD = 2 credits created_at: type: string format: date-time created_by: type: string credit_balance: type: string credits_available_breakdown: $ref: '#/components/schemas/types.CreditBreakdown' currency: type: string current_period_usage: type: string customer_id: type: string description: type: string environment_id: type: string id: type: string metadata: $ref: '#/components/schemas/types.Metadata' name: type: string real_time_balance: type: string real_time_credit_balance: type: string status: $ref: '#/components/schemas/types.Status' tenant_id: type: string topup_conversion_rate: type: string description: >- topup_conversion_rate is the conversion rate for the topup to the currency ex if topup_conversion_rate is 1, then 1 USD = 1 credit ex if topup_conversion_rate is 2, then 1 USD = 0.5 credits ex if topup_conversion_rate is 0.5, then 1 USD = 2 credits unpaid_invoices_amount: type: string updated_at: type: string format: date-time updated_by: type: string wallet_status: $ref: '#/components/schemas/types.WalletStatus' wallet_type: $ref: '#/components/schemas/types.WalletType' errors.ErrorResponse: type: object properties: code: type: string enum: - not_found - already_exists - version_conflict - validation_error - invalid_operation - permission_denied - http_client_error - database_error - system_error - internal_error - service_unavailable details: type: object additionalProperties: type: object http_status_code: type: integer message: type: string x-speakeasy-name-override: ErrorResponse types.AlertSettings: type: object properties: alert_enabled: type: boolean critical: $ref: '#/components/schemas/types.AlertThreshold' info: $ref: '#/components/schemas/types.AlertThreshold' warning: $ref: '#/components/schemas/types.AlertThreshold' x-speakeasy-name-override: AlertSettings types.AlertState: type: string enum: - ok - info - warning - in_alarm x-enum-varnames: - AlertStateOk - AlertStateInfo - AlertStateWarning - AlertStateInAlarm x-speakeasy-name-override: AlertState types.AutoTopup: type: object properties: amount: type: number enabled: type: boolean invoicing: type: boolean threshold: type: number x-speakeasy-name-override: AutoTopup types.WalletConfig: type: object properties: allowed_price_types: type: array description: >- AllowedPriceTypes is a list of price types that are allowed for the wallet nil means all price types are allowed items: $ref: '#/components/schemas/types.WalletConfigPriceType' x-speakeasy-name-override: WalletConfig types.CreditBreakdown: type: object properties: free: type: string purchased: type: string x-speakeasy-name-override: CreditBreakdown types.Metadata: type: object additionalProperties: type: string x-speakeasy-name-override: Metadata types.Status: type: string enum: - published - deleted - archived x-enum-varnames: - StatusPublished - StatusDeleted - StatusArchived x-speakeasy-name-override: Status types.WalletStatus: type: string enum: - active - frozen - closed x-enum-varnames: - WalletStatusActive - WalletStatusFrozen - WalletStatusClosed x-speakeasy-name-override: WalletStatus types.WalletType: type: string enum: - PRE_PAID - POST_PAID x-enum-varnames: - WalletTypePrePaid - WalletTypePostPaid x-speakeasy-name-override: WalletType types.AlertThreshold: type: object properties: condition: $ref: '#/components/schemas/types.AlertCondition' threshold: type: number x-speakeasy-name-override: AlertThreshold types.WalletConfigPriceType: type: string enum: - ALL - USAGE - FIXED x-enum-varnames: - WalletConfigPriceTypeAll - WalletConfigPriceTypeUsage - WalletConfigPriceTypeFixed x-speakeasy-name-override: WalletConfigPriceType types.AlertCondition: type: string enum: - above - below x-enum-varnames: - AlertConditionAbove - AlertConditionBelow x-speakeasy-name-override: AlertCondition securitySchemes: ApiKeyAuth: type: apiKey description: Enter your API key in the format *x-api-key <api-key>** name: x-api-key in: header ````