Skip to content
BoxBilling

Get wallet depletion forecast

GET
/v1/wallets/{wallet_id}/depletion_forecast

Get projected depletion date based on consumption rate.

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
wallet_id
required
Wallet Id
string format: uuid

Query Parameters

Section titled “Query Parameters ”
days
Days
integer
default: 30 >= 1 <= 365

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful Response

DepletionForecastResponse
object
wallet_id
required
Wallet Id
string format: uuid
current_balance_cents
required
Current Balance Cents
string
/^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$/
avg_daily_consumption
required
Avg Daily Consumption
string
/^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$/
projected_depletion_date
Any of:
string format: date-time
days_remaining
Any of:
integer

401

Section titled “401 ”

Unauthorized – invalid or missing API key

404

Section titled “404 ”

Wallet not found

422

Section titled “422 ”

Validation Error

HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object