payments.GetStarsSubscriptions

class pyrogram.raw.functions.payments.GetStarsSubscriptions

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

Details:

  • Layer: 223

  • ID: 32512C5

Parameters:

  • peer (InputPeer) – Always pass inputPeerSelf.

  • offset (str) – Offset for pagination, taken from payments.starsStatus.subscriptions_next_offset.

  • missing_balance (bool, optional) – Whether to return only subscriptions expired due to an excessively low Telegram Star balance.

Returns:

payments.StarsStatus

TL Schema

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

= payments.StarsStatus

Parameter Tree

GetStarsSubscriptions
├── missing_balance → true (optional)
├── peer → InputPeer
│ ├── InputPeerEmpty
│ ├── InputPeerSelf
│ ├── InputPeerChat
│ │ └── chat_id → long
│ ├── InputPeerUser
│ │ ├── user_id → long
│ │ └── access_hash → long
│ ├── InputPeerChannel
│ │ ├── channel_id → long
│ │ └── access_hash → long
│ ├── InputPeerUserFromMessage
│ │ ├── peer → InputPeer
│ │ │ ├── InputPeerEmpty
│ │ │ ├── InputPeerSelf
│ │ │ ├── InputPeerChat
│ │ │ ├── InputPeerUser
│ │ │ ├── InputPeerChannel
│ │ │ ├── InputPeerUserFromMessage
│ │ │ └── InputPeerChannelFromMessage
│ │ ├── msg_id → int
│ │ └── user_id → long
│ └── InputPeerChannelFromMessage
│ ├── peer → InputPeer
│ │ ├── InputPeerEmpty
│ │ ├── InputPeerSelf
│ │ ├── InputPeerChat
│ │ ├── InputPeerUser
│ │ ├── InputPeerChannel
│ │ ├── InputPeerUserFromMessage
│ │ └── InputPeerChannelFromMessage
│ ├── msg_id → int
│ └── channel_id → long
└── offset → string

Example

await app.invoke(
    GetStarsSubscriptions(
        missing_balance=None,
        peer=await app.resolve_peer(chat_id),
        offset="text",
    )
)