payments.StarsStatus

class pyrogram.raw.types.payments.StarsStatus[source]

Info about the current Telegram Star subscriptions, balance and transaction history ».

Constructor of StarsStatus.

Details:

  • Layer: 229

  • ID: 6C9CE8ED

Parameters:

  • balance (StarsAmount) – Current Telegram Star balance.

  • chats (List of Chat) – Chats mentioned in history.

  • users (List of User) – Users mentioned in history.

  • subscriptions (List of StarsSubscription, optional) – Info about current Telegram Star subscriptions, only returned when invoking payments.getStarsTransactions and payments.getStarsSubscriptions.

  • subscriptions_next_offset (str, optional) – Offset for pagination of subscriptions: only usable and returned when invoking payments.getStarsSubscriptions.

  • subscriptions_missing_balance (int 64-bit, optional) – The number of Telegram Stars the user should buy to be able to extend expired subscriptions soon (i.e. the current balance is not enough to extend all expired subscriptions).

  • history (List of StarsTransaction, optional) – List of Telegram Star transactions (partial if next_offset is set).

  • next_offset (str, optional) – Offset to use to fetch more transactions from the transaction history using payments.getStarsTransactions.

Functions:

This object can be returned by 4 functions.

payments.GetStarsStatus

Get the current Telegram Stars balance of the current account (with peer= inputPeerSelf ), or the stars balance of the bot or channel specified in peer.

payments.GetStarsTransactions

Fetch Telegram Stars transactions.

payments.GetStarsTransactionsByID

Obtain info about Telegram Star transactions » using specific transaction IDs.

payments.GetStarsSubscriptions

Obtain a list of active, expired or cancelled Telegram Star subscriptions ».