Home › Methods › Payments › GetStarsSubscriptions
Layer 220

PaymentsGetStarsSubscriptions

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

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

Parameters

Name Type Description
Flags # Flags, see TL conditional fields
MissingBalance flags.0?true Whether to return only subscriptions expired due to an excessively low Telegram Star balance.
Peer InputPeer Always pass input Peer Self.
Offset string Offset for pagination, taken from payments. stars Status. subscriptions_next_offset.

Returns

payments.StarsStatus

Possible Errors

Code Type Description
400 PEER_ID_INVALID The provided peer id is invalid.

Gogram Example

// PaymentsGetStarsSubscriptions - using Params struct
result, err := client.PaymentsGetStarsSubscriptions(&tg.PaymentsGetStarsSubscriptionsParams{
    Peer: &tg.InputPeerUser{UserID: int64(123456789)},
    Offset: "...",

    // Optional fields:
    // MissingBalance: true,
})
if err != nil {
    // handle error
}
// result is *tg.PaymentsStarsStatus