Interface StarGiveawayPaymentOption

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

interface StarGiveawayPaymentOption {
    @type: "starGiveawayPaymentOption";
    amount: number;
    currency: string;
    is_additional?: boolean;
    is_default?: boolean;
    star_count: number;
    store_product_id: string;
    winner_options: StarGiveawayWinnerOption[];
    yearly_boost_count: number;
}

Properties

@type amount currency is_additional? is_default? star_count store_product_id winner_options yearly_boost_count

Properties

@type

@type: "starGiveawayPaymentOption"

amount

amount: number

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

currency

currency: string

ISO 4217 currency code for the payment.

Optional is_additional

is_additional?: boolean

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

Optional is_default

is_default?: boolean

True, if the option must be chosen by default.

star_count

star_count: number

Number of Telegram Stars that will be distributed among winners.

store_product_id

store_product_id: string

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

winner_options

winner_options: StarGiveawayWinnerOption[]

Allowed options for the number of giveaway winners.

yearly_boost_count

yearly_boost_count: number

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

Settings

Member Visibility

Theme

On This Page

@typeamountcurrencyis_additionalis_defaultstar_countstore_product_idwinner_optionsyearly_boost_count