Skip to main content

Wallet object

This object represents a wallet.

Schema

{
"wallet": {
"lago_id": "b7ab2926-1de8-4428-9bcd-779314ac129b",
"lago_customer_id": "12345",
"external_customer_id": "12345678",
"status": "active",
"currency": "EUR",
"name": "name",
"rate_amount": "1.5",
"credits_balance": "10.0",
"balance": "10.0",
"consumed_credits": "2.0",
"created_at": "2022-04-29T08:59:51Z",
"expiration_date": null,
"last_balance_sync_at": "2022-04-29T08:59:51Z",
"last_consumed_credit_at": "2022-04-29T08:59:51Z"
}
}
AttributesDescription
lago_id     String     Not nullUnique identifier of the wallet in Lago application.
lago_customer_id     String     Not nullInternal Lago customer ID.
external_customer_id     String     Not nullExternal customer ID.
status     String     Not null
Status.
Possible values
- active
- terminated
currency     String     Not nullCurrency.
name     StringWallet name.
rate_amount     String     Not nullRate used for conversion between credits and amount in given currency.
credits_balance     String     Not nullBalance in credits.
balance     String     Not nullBalance in specified currency.
consumed_credits     String     Not nullCredits consumed.
created_at     String     Not null    
ISO 8601 datetime in UTC
Date of wallet creation.
expiration_date     String
ISO 8601 datetime in UTC
Date of wallet expiration.
last_balance_sync_at     String
ISO 8601 datetime in UTC
Date of last wallet top-up.
last_consumed_credit_at     String
ISO 8601 datetime in UTC
Date of last wallet consumption.
terminated_at     String
ISO 8601 datetime in UTC
Date of wallet termination.