A ledger_account_balance_monitor is an object that stores an alert_condition for which, when the account's values cross the alert_condition, a webhook is sent. Each ledger account balance monitor belongs to a ledger_account.
| Attribute | Description |
|---|---|
| id string | Unique identifier for the ledger account balance monitor. |
| description string | An optional free-form description for internal use. |
| alert_condition object | Describes the condition that must be satisfied for the monitor to be triggered. |
| current_ledger_account_balance_state object | The ledger account's balances and the monitor state as of the current ledger account lock version. |
| ledger_account_id string | The ledger account associated with this balance monitor. |
| live_mode boolean | This field will be true if this object was created with a production API key or false if created with a test API key. |
| metadata object | Additional data represented as key-value pairs. Both the key and value must be strings. See Metadata. |
{
"id": "36f99587-e551-4836-bab5-62250338ef70",
"object": "ledger_account_balance_monitor",
"live_mode": true,
"ledger_account_id": "895cf384-3d37-48bf-b04d-ea34bf358079",
"description": "Alert when balance changes",
"alert_condition": {
"field": "available_amount",
"operator": "greater_than",
"value": 0
},
"current_ledger_account_balance_state": {
"balances": {
"pending_balance": {
"credits": 0,
"debits": 0,
"amount": 0,
"currency": "USD",
"currency_exponent": 2
},
"posted_balance": {
"credits": 0,
"debits": 0,
"amount": 0,
"currency": "USD",
"currency_exponent": 2
},
"available_balance": {
"credits": 0,
"debits": 0,
"amount": 0,
"currency": "USD",
"currency_exponent": 2
}
},
"ledger_account_lock_version": 0,
"triggered": false
},
"metadata": {},
"discarded_at": null,
"created_at": "2023-08-14T17:22:37Z",
"updated_at": "2023-08-14T17:22:37Z"
}