StarsRevenueStatus

class pyrogram.raw.types.StarsRevenueStatus

Describes Telegram Star revenue balances ».

Constructor of StarsRevenueStatus.

Details:

  • Layer: 223

  • ID: FEBE5491

Parameters:

  • current_balance (StarsAmount) – Amount of not-yet-withdrawn Telegram Stars.

  • available_balance (StarsAmount) – Amount of withdrawable Telegram Stars.

  • overall_revenue (StarsAmount) – Total amount of earned Telegram Stars.

  • withdrawal_enabled (bool, optional) – If set, the user may withdraw up to available_balance stars.

  • next_withdrawal_at (int 32-bit, optional) – Unixtime indicating when will withdrawal be available to the user. If not set, withdrawal can be started now.

TL Schema

starsRevenueStatus#febe5491
flags:#
withdrawal_enabled:flags.0?true
current_balance:StarsAmount
available_balance:StarsAmount
overall_revenue:StarsAmount
next_withdrawal_at:flags.1?int

= StarsRevenueStatus

Parameter Tree

StarsRevenueStatus
├── withdrawal_enabled → true (optional)
├── current_balance → StarsAmount
│ ├── StarsAmount
│ │ ├── amount → long
│ │ └── nanos → int
│ └── StarsTonAmount
│ └── amount → long
├── available_balance → StarsAmount
│ ├── StarsAmount
│ │ ├── amount → long
│ │ └── nanos → int
│ └── StarsTonAmount
│ └── amount → long
├── overall_revenue → StarsAmount
│ ├── StarsAmount
│ │ ├── amount → long
│ │ └── nanos → int
│ └── StarsTonAmount
│ └── amount → long
└── next_withdrawal_at → int (optional)

Example

StarsRevenueStatus(
    current_balance=StarsAmount(
        amount=0,
        nanos=0
    ),
    available_balance=StarsAmount(
        amount=0,
        nanos=0
    ),
    overall_revenue=StarsAmount(
        amount=0,
        nanos=0
    ),
)