{
  "wallet": {
    "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",
    "recurring_transaction_rules": [
      {
        "lago_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
        "rule_type": "interval",
        "interval": "monthly",
        "threshold_credits": "20.0",
        "paid_credits": "20.0",
        "granted_credits": "10.0",
        "created_at": "2022-04-29T08:59:51Z"
      }
    ],
    "ongoing_balance_cents": 800,
    "ongoing_usage_balance_cents": 200,
    "credits_ongoing_balance": "8.0",
    "credits_ongoing_usage_balance": "2.0"
  }
}

​
Attributes

wallet
object
balance_cents
integer
required

The current wallet balance expressed in cents.

consumed_credits
string
required

The number of consumed credits.

created_at
string
required

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

credits_balance
string
required

The current wallet balance expressed in credits.

currency
string
required

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).

external_customer_id
string
required

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

lago_customer_id
string
required

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.

lago_id
string
required

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.

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).

name
string
required

The name of the wallet.

rate_amount
string
required

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.

status
string
required

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

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).

recurring_transaction_rules
array

List of recurring transaction rules. Currently, we only allow one recurring rule per wallet.

ongoing_balance_cents
integer
required

The wallet ongoing balance expressed in cents.

ongoing_usage_balance_cents
integer
required

The wallet ongoing usage balance expressed in cents.

credits_ongoing_balance
string
required

The wallet ongoing balance expressed in credits.

credits_ongoing_usage_balance
string
required

The wallet ongoing usage balance expressed in credits.

Was this page helpful?

List all tax ratesCreate a wallet