telegram api method · layer 229 · #032512c5

payments.getStarsSubscriptions

usable by users

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

definition

payments.getStarsSubscriptions#32512c5 flags:# missing_balance:flags.0?true peer:InputPeer offset:string = payments.StarsStatus;

parameters

nametypedescription
flags#Flags, see TL conditional fields
missing_balanceflags.0?trueWhether to return only subscriptions expired due to an excessively low Telegram Star balance.
peerInputPeerAlways pass inputPeerSelf.
offsetstringOffset for pagination, taken from payments.starsStatus.subscriptions_next_offset.

returns

payments.StarsStatus

errors (3)

codeerrordescription
400BUSINESS_CONNECTION_NOT_ALLOWEDThis method was invoked over a business connection using invokeWithBusinessConnection, but either (1) we're a user, and users cannot invoke methods over a business connection; (2) we're a bot, but business mode was disabled in @botfather or (3); we're a bot, but this method cannot be invoked over a business connection.
400PEER_ID_INVALIDThe provided peer id is invalid.
401AUTH_KEY_UNREGISTEREDThe specified authorization key is not registered in the system (for example, a PFS temporary key has expired).

history

present in layers 186–229

idlayers
#032512c5186–229