Skip to content

StarGiveawayPaymentOption

Type · TDLib 1.8.67 · d1085f9c

Describes an option for creating of Telegram Star giveaway. Use telegramPaymentPurposeStarGiveaway for out-of-store payments

StarGiveawayPaymentOption(
  currency: string,
  amount: int53,
  star_count: int53,
  store_product_id: string,
  yearly_boost_count: int32,
  winner_options: list of StarGiveawayWinnerOption,
  is_default: Bool,
  is_additional: Bool
) → StarGiveawayPaymentOption

currency

string

ISO 4217 currency code for the payment

amount

int53

The amount to pay, in the smallest units of the currency

star_count

int53

Number of Telegram Stars that will be distributed among winners

store_product_id

string

Identifier of the store product associated with the option; may be empty if none

yearly_boost_count

int32

Number of times the chat will be boosted for one year if the option is chosen

winner_options

list of StarGiveawayWinnerOption

Allowed options for the number of giveaway winners

is_default

Bool

True, if the option must be chosen by default

is_additional

Bool

True, if the option must be shown only in the full list of payment options