diff --git a/47.md b/47.md index 983d2c954a..9c6fbdb10b 100644 --- a/47.md +++ b/47.md @@ -373,6 +373,34 @@ Response: } ``` +### `get_budget` + +Budgets can be used to limit the amount of funds that can be spent by a connection in a given time period. +Budgets are optional and can be set by the user if their wallet supports it. Support for this command indicates +that the wallet supports user-configured budgets. The budget will be reset at the `renews_at` timestamp. + +Request: +```jsonc +{ + "method": "get_budget", + "params": { + } +} +``` + +Response: +```jsonc +{ + "result_type": "get_budget", + "result": { + "used_budget": 10000, // used budget amount in msats + "total_budget": 100000, // total budget amount in msats + "renews_at": 1693876973, // timestamp in seconds since epoch, optional. If not provided, the budget does not renew. + "renewal_period": "monthly", // daily|weekly|monthly|yearly|never + } +} +``` + ### `get_info` Request: