---
title: "Get Customer Wallets"
method: GET
path: "/customers/wallets"
tags: ["Wallets"]
---

# Get Customer Wallets

`GET /customers/wallets`

Use when resolving wallets by external customer id or lookup key (e.g. from your app's user id). Supports optional real-time balance and expand.

## Query parameters

- `-` integer
- `expand` string
- `from_cache` boolean
- `id` string
- `include_real_time_balance` boolean
- `lookup_key` string

## Response `200`

OK

- WalletResponse[]
  - `alert_settings` TypesAlertSettings
    - `alert_enabled` boolean
    - `critical` TypesAlertThreshold
      - `condition` 'above' | 'below'
      - `threshold` string
    - `info` TypesAlertThreshold
      - `condition` 'above' | 'below'
      - `threshold` string
    - `warning` TypesAlertThreshold
      - `condition` 'above' | 'below'
      - `threshold` string
  - `alert_state` 'ok' | 'info' | 'warning' | 'in_alarm'
  - `auto_topup` TypesAutoTopup
    - `amount` number
    - `cooldown` TypesDuration
      - `unit` 'second' | 'minute' | 'hour' | 'day'
      - `value` integer
    - `enabled` boolean
    - `invoicing` boolean
    - `threshold` number
  - `balance` string
  - `config` TypesWalletConfig
    - `allowed_price_types` TypesWalletConfigPriceType[] — AllowedPriceTypes is a list of price types that are allowed for the wallet nil means all price types are allowed
  - `conversion_rate` string — 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` string, date-time
  - `created_by` string
  - `credit_balance` string
  - `credits_available_breakdown` TypesCreditBreakdown
    - `free` string
    - `purchased` string
  - `currency` string
  - `customer_id` string
  - `description` string
  - `environment_id` string
  - `id` string
  - `metadata` TypesMetadata
  - `name` string
  - `real_time_balance` string
  - `real_time_credit_balance` string
  - `status` 'published' | 'deleted' | 'archived'
  - `tenant_id` string
  - `topup_conversion_rate` string — 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
  - `updated_at` string, date-time
  - `updated_by` string
  - `wallet_status` 'active' | 'frozen' | 'closed'
  - `wallet_type` 'PRE_PAID' | 'POST_PAID'

## Other responses

- `400` — Invalid request
- `404` — Resource not found
- `500` — Server error

---

[API](https://skmtc.net/flexprice/apis/flexprice-api.md) · [All operations](https://skmtc.net/flexprice/apis/flexprice-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/flexprice/flexprice-api/versions/f0601ed97bd3/schema)