GramIO API Reference / gramio/dist / GiftPremiumSubscriptionParams
Interface: GiftPremiumSubscriptionParams
Defined in: @gramio/types/out/params.d.ts:2763
Params object for giftPremiumSubscription method
Properties
| Property | Type | Description | Defined in |
|---|---|---|---|
month_count | GiftPremiumSubscriptionMonthCount | Number of months the Telegram Premium subscription will be active for the user; must be one of 3, 6, or 12 | @gramio/types/out/params.d.ts:2771 |
star_count | number | 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 | @gramio/types/out/params.d.ts:2775 |
text? | string | { toString: string; } | Text that will be shown along with the service message about the subscription; 0-128 characters | @gramio/types/out/params.d.ts:2779 |
text_entities? | TelegramMessageEntity[] | 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. | @gramio/types/out/params.d.ts:2787 |
text_parse_mode? | "HTML" | "MarkdownV2" | "Markdown" | 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. | @gramio/types/out/params.d.ts:2783 |
user_id | number | Unique identifier of the target user who will receive a Telegram Premium subscription | @gramio/types/out/params.d.ts:2767 |