Link Search Menu Expand Document

Constructor: broadcastRevenueBalances

Back to constructors index

Describes channel ad revenue balances ».

Note that all balances are in the smallest unit of the chosen cryptocurrency (currently nanotons for TONs, so to obtain a value in USD divide the chosen amount by 10^9, and then divide by usd_rate).

Attributes:

NameTypeRequiredDescription
withdrawal_enabledBoolOptionalIf set, the available balance can be withdrawn ».
current_balancelongYesAmount of not-yet-withdrawn cryptocurrency.
available_balancelongYesAmount of withdrawable cryptocurrency, out of the currently available balance (available_balance <= current_balance).
overall_revenuelongYesTotal amount of earned cryptocurrency.

Type: BroadcastRevenueBalances

Example:

$broadcastRevenueBalances = ['_' => 'broadcastRevenueBalances', 'withdrawal_enabled' => Bool, 'current_balance' => long, 'available_balance' => long, 'overall_revenue' => long];