haskell-tdlib-2.0.63.0
Safe HaskellSafe-Inferred
LanguageGHC2021

TD.Data.TelegramPaymentPurpose

Synopsis

Documentation

data TelegramPaymentPurpose Source #

Describes a purpose of a payment toward Telegram

Constructors

TelegramPaymentPurposePremiumGift

The user gifting Telegram Premium to another user

Fields

  • currency :: Maybe Text

    ISO 4217 currency code of the payment currency, or XTR for payments in Telegram Stars

  • amount :: Maybe Int

    Paid amount, in the smallest units of the currency

  • user_id :: Maybe Int

    Identifier of the user which will receive Telegram Premium

  • month_count :: Maybe Int

    Number of months the Telegram Premium subscription will be active for the user

  • text :: Maybe FormattedText

    Text to show to the user receiving Telegram Premium; 0-getOption("gift_text_length_max") characters. Only Bold, Italic, Underline, Strikethrough, Spoiler, and CustomEmoji entities are allowed

TelegramPaymentPurposePremiumGiftCodes

The user boosting a chat by creating Telegram Premium gift codes for other users

Fields

  • boosted_chat_id :: Maybe Int

    Identifier of the supergroup or channel chat, which will be automatically boosted by the users for duration of the Premium subscription and which is administered by the user

  • currency :: Maybe Text

    ISO 4217 currency code of the payment currency, or XTR for payments in Telegram Stars

  • amount :: Maybe Int

    Paid amount, in the smallest units of the currency

  • user_ids :: Maybe [Int]

    Identifiers of the users which can activate the gift codes

  • month_count :: Maybe Int

    Number of months the Telegram Premium subscription will be active for the user

  • text :: Maybe FormattedText

    Text to show to the user receiving Telegram Premium; 0-getOption("gift_text_length_max") characters. Only Bold, Italic, Underline, Strikethrough, Spoiler, and CustomEmoji entities are allowed

TelegramPaymentPurposePremiumGiveaway

The user creating a Telegram Premium giveaway

Fields

TelegramPaymentPurposeStars

The user buying Telegram Stars

Fields

TelegramPaymentPurposeGiftedStars

The user buying Telegram Stars for other users

Fields

TelegramPaymentPurposeStarGiveaway

The user creating a Telegram Star giveaway

Fields

TelegramPaymentPurposeJoinChat

The user joins a chat and subscribes to regular payments in Telegram Stars

Fields