Skip to main content
POST
/
wallets
/
search
Query wallets
curl --request POST \
  --url https://us.api.flexprice.io/v1/wallets/search \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "alert_enabled": true,
  "expand": "<string>",
  "limit": 500,
  "offset": 1,
  "sort": "<string>",
  "wallet_ids": [
    "<string>"
  ]
}
'
{
  "items": [
    {
      "alert_settings": {
        "alert_enabled": true,
        "critical": {
          "threshold": 123
        },
        "info": {
          "threshold": 123
        },
        "warning": {
          "threshold": 123
        }
      },
      "auto_topup": {
        "amount": 123,
        "enabled": true,
        "invoicing": true,
        "threshold": 123
      },
      "balance": "<string>",
      "config": {
        "allowed_price_types": []
      },
      "conversion_rate": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "created_by": "<string>",
      "credit_balance": "<string>",
      "credits_available_breakdown": {
        "free": "<string>",
        "purchased": "<string>"
      },
      "currency": "<string>",
      "customer_id": "<string>",
      "description": "<string>",
      "environment_id": "<string>",
      "id": "<string>",
      "metadata": {},
      "name": "<string>",
      "tenant_id": "<string>",
      "topup_conversion_rate": "<string>",
      "updated_at": "2023-11-07T05:31:56Z",
      "updated_by": "<string>"
    }
  ],
  "pagination": {
    "limit": 123,
    "offset": 123,
    "total": 123
  }
}

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.

Authorizations

​
x-api-key
string
header
required

Enter your API key in the format x-api-key <api-key>*

Body

application/json

Filter

​
alert_enabled
boolean
​
expand
string
​
limit
integer
Required range: 1 <= x <= 1000
​
offset
integer
Required range: x >= 0
​
order
enum<string>
Available options:
asc,
desc
​
sort
string
​
status
enum<string>
Available options:
active,
frozen,
closed
​
wallet_ids
string[]

Response

OK

​
items
object[]
​
pagination
object