Link Search Menu Expand Document

Constructor: payments.starsStatus

Back to constructors index

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

Attributes:

NameTypeRequiredDescription
balanceStarsAmountYesCurrent Telegram Star balance.
subscriptionsArray of StarsSubscriptionOptionalInfo about current Telegram Star subscriptions, only returned when invoking payments.getStarsTransactions and payments.getStarsSubscriptions.
subscriptions_next_offsetstringOptionalOffset for pagination of subscriptions: only usable and returned when invoking payments.getStarsSubscriptions.
subscriptions_missing_balancelongOptionalThe 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).
historyArray of StarsTransactionOptionalList of Telegram Star transactions (partial if next_offset is set).
next_offsetstringOptionalOffset to use to fetch more transactions from the transaction history using payments.getStarsTransactions.
chatsArray of ChatYesChats mentioned in history.
usersArray of UserYesUsers mentioned in history.

Type: payments.StarsStatus

Example:

$payments_starsStatus = ['_' => 'payments.starsStatus', 'balance' => StarsAmount, 'subscriptions' => [StarsSubscription, StarsSubscription], 'subscriptions_next_offset' => 'string', 'subscriptions_missing_balance' => long, 'history' => [StarsTransaction, StarsTransaction], 'next_offset' => 'string', 'chats' => [Chat, Chat], 'users' => [User, User]];