Link Search Menu Expand Document

Constructor: starsRevenueStatus

Back to constructors index

Describes Telegram Star revenue balances ».

Attributes:

NameTypeRequiredDescription
withdrawal_enabledBoolOptionalIf set, the user may withdraw up to available_balance stars.
current_balanceStarsAmountYesAmount of not-yet-withdrawn Telegram Stars.
available_balanceStarsAmountYesAmount of withdrawable Telegram Stars.
overall_revenueStarsAmountYesTotal amount of earned Telegram Stars.
next_withdrawal_atintOptionalUnixtime indicating when will withdrawal be available to the user. If not set, withdrawal can be started now.

Type: StarsRevenueStatus

Example:

$starsRevenueStatus = ['_' => 'starsRevenueStatus', 'withdrawal_enabled' => Bool, 'current_balance' => StarsAmount, 'available_balance' => StarsAmount, 'overall_revenue' => StarsAmount, 'next_withdrawal_at' => int];