telebot-ts API Documentation - v1.0.0
    Preparing search index...

    Interface SendInvoiceOptions

    interface SendInvoiceOptions {
        allow_paid_broadcast?: boolean;
        chat_id: string | number;
        currency: string;
        description: string;
        direct_messages_topic_id?: number;
        disable_notification?: boolean;
        is_flexible?: boolean;
        max_tip_amount?: number;
        message_effect_id?: string;
        message_thread_id?: number;
        need_email?: boolean;
        need_name?: boolean;
        need_phone_number?: boolean;
        need_shipping_address?: boolean;
        payload: string;
        photo_height?: number;
        photo_size?: number;
        photo_url?: string;
        photo_width?: number;
        prices: LabeledPrice[];
        protect_content?: boolean;
        provider_data?: string;
        provider_token?: string;
        reply_markup?: InlineKeyboardMarkup;
        reply_parameters?: ReplyParameters;
        send_email_to_provider?: boolean;
        send_phone_number_to_provider?: boolean;
        start_parameter?: string;
        suggested_post_parameters?: SuggestedPostParameters;
        suggested_tip_amounts?: number[];
        title: string;
    }
    Index
    allow_paid_broadcast? chat_id currency description direct_messages_topic_id? disable_notification? is_flexible? max_tip_amount? message_effect_id? message_thread_id? need_email? need_name? need_phone_number? need_shipping_address? payload photo_height? photo_size? photo_url? photo_width? prices protect_content? provider_data? provider_token? reply_markup? reply_parameters? send_email_to_provider? send_phone_number_to_provider? start_parameter? suggested_post_parameters? suggested_tip_amounts? title
    allow_paid_broadcast?: boolean

    Pass True to allow paid broadcast of the message.

    chat_id: string | number

    Unique identifier for the target chat or username of the target channel.

    currency: string

    Three-letter ISO 4217 currency code or 'XTR' for Telegram Stars.

    description: string

    Product description, 1-255 characters.

    direct_messages_topic_id?: number

    Identifier of the topic the message will be sent to in a direct messages chat.

    disable_notification?: boolean

    Sends the message silently. Users will receive a notification with no sound.

    is_flexible?: boolean

    Pass True if the final price depends on the shipping method.

    max_tip_amount?: number

    The maximum accepted amount for tips in the smallest units of the currency.

    message_effect_id?: string

    Unique identifier of the message effect to be added to the message.

    message_thread_id?: number

    Unique identifier for the target message thread (topic) of the forum.

    need_email?: boolean

    Pass True if you require the user's email address to complete the order.

    need_name?: boolean

    Pass True if you require the user's full name to complete the order.

    need_phone_number?: boolean

    Pass True if you require the user's phone number to complete the order.

    need_shipping_address?: boolean

    Pass True if you require the user's shipping address to complete the order.

    payload: string

    Bot-defined invoice payload, 1-128 bytes.

    photo_height?: number

    Photo height.

    photo_size?: number

    Photo size in bytes.

    photo_url?: string

    URL of the product photo for the invoice.

    photo_width?: number

    Photo width.

    prices: LabeledPrice[]

    Price breakdown, a JSON-serialized list of components.

    Optionalprotect_content

    protect_content?: boolean

    Protects the contents of the sent message from forwarding and saving.

    provider_data?: string

    JSON-serialized data about the invoice, which will be shared with the payment provider.

    provider_token?: string

    Payment provider token, obtained via @BotFather. Pass an empty string for payments in Telegram Stars.

    reply_markup?: InlineKeyboardMarkup

    An inline keyboard.

    reply_parameters?: ReplyParameters

    Description of the message to reply to.

    send_email_to_provider?: boolean

    Pass True if the user's email address should be sent to the provider.

    send_phone_number_to_provider?: boolean

    Pass True if the user's phone number should be sent to the provider.

    start_parameter?: string

    Unique deep-linking parameter.

    Optionalsuggested_post_parameters

    suggested_post_parameters?: SuggestedPostParameters

    Parameters of the suggested post to send in a business chat.

    suggested_tip_amounts?: number[]

    A JSON-serialized array of suggested amounts of tips in the smallest units of the currency.

    title: string

    Product name, 1-32 characters.

    Settings
    Member Visibility

    On This Page
    Properties