wallets

List all wallets

Changed on Nov 3, 2026

This endpoint is used to list all wallets with prepaid credits.

get/wallets

Request

Base URL
https://api.getlago.com/api/v1
Auth
HTTP bearer
TypeScript
https://skmtc.dev/getlago/apis/lago-api-documentation/docs/wallets/get.ts
A function with typed inputs. Its response is checked against the schema.

Query parameters

pageinteger

Example:1

Page number. Defaults to 1. A value that is not a positive integer, such as 0, returns the first page.

per_pageinteger

Example:20

Number of records per page. Defaults to 100. The maximum is 200, unless another maximum is configured for your organization. A value above the maximum returns a 422 error with value_is_out_of_range on per_page. A value that is not a positive integer, such as 0, returns the default number of records.

currencystring

Example:EUR

Filter the results by currency, expressed as an ISO 4217 code.

external_customer_idstring

Example:5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba

Filter wallets by customer external unique identifier (provided by your own application). When omitted, all wallets for the organization are returned.

billing_entity_codes[]string[]

Filter wallets by billing entity codes.

[
  "billing_entity_code_1",
  "billing_entity_code_2"
]

Response

Wallets

Example response

{
  "wallets": [
    {
      "lago_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
      "lago_customer_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
      "external_customer_id": "hooli_1234",
      "billing_entity_code": "default",
      "status": "active",
      "currency": "USD",
      "name": "Prepaid",
      "code": "prepaid",
      "priority": 50,
      "rate_amount": "1.5",
      "credits_balance": "28.0",
      "balance_cents": 1000,
      "consumed_credits": "2.0",
      "created_at": "2022-04-29T08:59:51Z",
      "last_balance_sync_at": "2022-04-29T08:59:51Z",
      "last_consumed_credit_at": "2022-04-29T08:59:51Z",
      "terminated_at": "2022-09-14T16:35:31Z",
      "applies_to": {
        "fee_types": [
          "charge"
        ],
        "billable_metric_codes": [
          "bm1"
        ]
      },
      "recurring_transaction_rules": [
        {
          "lago_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
          "trigger": "interval",
          "method": "target",
          "interval": "monthly",
          "status": "active",
          "threshold_credits": "20.0",
          "paid_credits": "20.0",
          "granted_credits": "10.0",
          "started_at": "2022-08-08T00:00:00Z",
          "target_ongoing_balance": "200.0",
          "created_at": "2022-04-29T08:59:51Z",
          "expiration_at": "2023-09-30T23:59:59Z",
          "transaction_metadata": [
            {
              "key": "example_key",
              "value": "example_value"
            },
            {
              "key": "another_key",
              "value": "another_value"
            }
          ],
          "transaction_name": "Tokens for models 'high-fidelity-boost'",
          "applied_invoice_custom_sections": [
            {
              "lago_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
              "created_at": "2023-07-06T14:35:58Z",
              "invoice_custom_section_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
              "invoice_custom_section": {
                "lago_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
                "name": "EU Bank Details",
                "code": "eu_bank_details",
                "description": "This section contains the bank details for EU customers.",
                "details": "Bank Name: Lago Bank, IBAN: FR7630004000031234567890143",
                "display_name": "Bank Details:",
                "applied_to_organization": true,
                "organization_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
                "created_at": "2023-07-06T14:35:58Z"
              }
            }
          ],
          "payment_method": {
            "payment_method_type": "provider",
            "payment_method_id": "1a901a90-1a90-1a90-1a90-1a901a901a90"
          },
          "purchase_order_number": "PO-123"
        }
      ],
      "ongoing_balance_cents": 800,
      "ongoing_usage_balance_cents": 200,
      "credits_ongoing_balance": "8.0",
      "credits_ongoing_usage_balance": "2.0",
      "paid_top_up_min_amount_cents": 100,
      "paid_top_up_max_amount_cents": 1000,
      "applied_invoice_custom_sections": [
        {
          "lago_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
          "created_at": "2023-07-06T14:35:58Z",
          "invoice_custom_section_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
          "invoice_custom_section": {
            "lago_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
            "name": "EU Bank Details",
            "code": "eu_bank_details",
            "description": "This section contains the bank details for EU customers.",
            "details": "Bank Name: Lago Bank, IBAN: FR7630004000031234567890143",
            "display_name": "Bank Details:",
            "applied_to_organization": true,
            "organization_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
            "created_at": "2023-07-06T14:35:58Z"
          }
        }
      ],
      "payment_method": {
        "payment_method_type": "provider",
        "payment_method_id": "1a901a90-1a90-1a90-1a90-1a901a901a90"
      },
      "purchase_order_number": "PO-123",
      "metadata": {
        "external_id": "ext-123",
        "synced_at": "2024-01-15",
        "source": null
      }
    }
  ],
  "meta": {
    "current_page": 2,
    "next_page": 3,
    "prev_page": 1,
    "total_pages": 4,
    "total_count": 70
  }
}

Changes

Nov 3, 20265d26657495a3 Revision changes
- breaking
  the response property //// became nullable for the status
- warning
  added the new SYP enum value to the // response property for the response status
- warning
  added the new TND enum value to the // response property for the response status
- warning
  added the new credit enum value to the //// response property for the response status
- warning
  added the new fixed_charge enum value to the //// response property for the response status
- warning
  added the new undefined enum value to the //// response property for the response status
- info
  the query request parameter external_customer_id became optional
- info
  added the non-success response with the status
- info
  the response property // became required for the status
- info
  the response property // became required for the status
- info
  the response property // became required for the status
- info
  the response property // became required for the status
- info
  the response property // became required for the status
- info
  the response property // became required for the status
- info
  the response property // became required for the status
- info
  the response property // became required for the status
- info
  the response property // became required for the status
- info
  the response property // became required for the status
- info
  the response property //// became required for the status
- info
  the response property //// became required for the status
- info
  the response property // became required for the status
- info
  added the required property // to the response with the status
- info
  added the required property //// to the response with the status

Operation history