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_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"
  }
}

Attributes	Description
lago_id     String     Not null	Unique identifier of the wallet in Lago application.
lago_customer_id     String     Not null	Internal Lago customer ID.
external_customer_id     String     Not null	External customer ID.
status     String     Not null	Status. Possible values - active - terminated
currency     String     Not null	Currency.
name     String	Wallet name.
rate_amount     String     Not null	Rate used for conversion between credits and amount in given currency.
credits_balance     String     Not null	Balance in credits.
balance_cents     Integer     Not null	Balance in cents in specified currency.
consumed_credits     String     Not null	Credits consumed.
created_at     String     Not null     ISO 8601 datetime in UTC	Date of wallet creation.
expiration_at     String ISO 8601 datetime in UTC	Date and time 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.

Deprecated attributes

Attributes	Description
expiration_date     String ISO 8601 datetime in UTC	Date of wallet expiration.
balance     String	Balance in specified currency