peyk.platforms.telegram.methods.gift_premium_subscription

async peyk.platforms.telegram.methods.gift_premium_subscription(self, user_id: int, month_count: int, star_count: int | None = None, *, text: str | None = None, text_parse_mode: str | None = None, text_entities: List[MessageEntity] | None = None) → bool

Gifts a Telegram Premium subscription to the given user. Returns True on success.

Parameters:

  • user_id – Unique identifier of the target user who will receive a Telegram Premium subscription

  • month_count – Number of months the Telegram Premium subscription will be active for the user; must be one of 3, 6, or 12

  • star_count – Number of Telegram Stars to pay for the Telegram Premium subscription; must be 1000 for 3 months, 1500 for 6 months, and 2500 for 12 months

  • text – Text that will be shown along with the service message about the subscription; 0-128 characters

  • text_parse_mode – Mode for parsing entities in the text. See formatting options for more details. Entities other than ‘bold’, ‘italic’, ‘underline’, ‘strikethrough’, ‘spoiler’, ‘custom_emoji’, and ‘date_time’ are ignored.

  • text_entities – A JSON-serialized list of special entities that appear in the gift text. It can be specified instead of text_parse_mode. Entities other than ‘bold’, ‘italic’, ‘underline’, ‘strikethrough’, ‘spoiler’, ‘custom_emoji’, and ‘date_time’ are ignored.

Returns:

Result returned by Telegram on successful execution.

Return type:

bool