GET
/
wallets
LAGO_URL="https://api.getlago.com"
API_KEY="__YOUR_API_KEY__"

curl --location --request GET "$LAGO_URL/api/v1/wallets?external_customer_id&per_page=2&page=1" \
  --header "Authorization: Bearer $API_KEY"

{
  "wallets": [
    {
      "lago_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
      "lago_customer_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
      "external_customer_id": "hooli_1234",
      "status": "active",
      "currency": "USD",
      "name": "Prepaid",
      "rate_amount": "1.5",
      "credits_balance": "28.0",
      "balance_cents": 1000,
      "consumed_credits": "2.0",
      "created_at": "2022-04-29T08:59:51Z",
      "expiration_at": null,
      "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",
      "invoice_requires_successful_payment": false,
      "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",
          "invoice_requires_successful_payment": false,
          "transaction_metadata": [
            {
              "key": "example_key",
              "value": "example_value"
            },
            {
              "key": "another_key",
              "value": "another_value"
            }
          ]
        }
      ],
      "ongoing_balance_cents": 800,
      "ongoing_usage_balance_cents": 200,
      "credits_ongoing_balance": "8.0",
      "credits_ongoing_usage_balance": "2.0"
    }
  ],
  "meta": {
    "current_page": 2,
    "next_page": 3,
    "prev_page": 1,
    "total_pages": 4,
    "total_count": 70
  }
}
LAGO_URL="https://api.getlago.com"
API_KEY="__YOUR_API_KEY__"

curl --location --request GET "$LAGO_URL/api/v1/wallets?external_customer_id&per_page=2&page=1" \
  --header "Authorization: Bearer $API_KEY"

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
page
integer

Page number.

Example:

1

​
per_page
integer

Number of records per page.

Example:

20

​
external_customer_id
string
required

The customer external unique identifier (provided by your own application).

Example:

"5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba"

Response

200
application/json
Wallets

The response is of type object.