{
  "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

wallet
object
lago_idrequired
string

Unique identifier assigned to the wallet within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the wallet’s record within the Lago system.

lago_customer_idrequired
string

Unique identifier assigned to the customer within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the customer’s record within the Lago system.

external_customer_idrequired
string

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

statusrequired
string

The status of the wallet. Possible values are active or terminated.

namerequired
string

The name of the wallet.

rate_amountrequired
string

The rate of conversion between credits and the amount in the specified currency. It indicates the ratio or factor used to convert credits into the corresponding monetary value in the currency of the transaction.

paid_credits
string

The number of paid credits. Required only if there is no granted credits.

granted_credits
string

The number of free granted credits. Required only if there is no paid credits.

currencyrequired
string

The currency of the wallet.

expiration_at
string

The date and time that determines when the wallet will expire. It follows the ISO 8601 datetime format and is expressed in Coordinated Universal Time (UTC).

credits_balancerequired
string

The current wallet balance expressed in credits.

balance_centsrequired
integer

The current wallet balance expressed in cents.

consumed_creditsrequired
string

The number of consumed credits.

created_atrequired
string

The date of the wallet creation, represented in ISO 8601 datetime format and expressed in Coordinated Universal Time (UTC).

last_balance_sync_at
string

The date and time of the last balance top-up. It follows the ISO 8601 datetime format and is expressed in Coordinated Universal Time (UTC).

last_consumed_credit_at
string

The date and time of the last credits consumption. It follows the ISO 8601 datetime format and is expressed in Coordinated Universal Time (UTC).

terminated_at
string

The date of terminaison of the wallet. It follows the ISO 8601 datetime format and is expressed in Coordinated Universal Time (UTC).