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

    Interface CreateInvoiceLinkOptions

    Options for Bot.createInvoiceLink.

    Mirrors the documented 22-parameter createInvoiceLink set exactly. Unlike sendInvoice it has no chat_id and no message-delivery fields (disable_notification, message_thread_id, protect_content, reply_parameters, reply_markup, start_parameter), and it supports subscription_period for recurring charges.

    Telegram Bot API: createInvoiceLink

    interface CreateInvoiceLinkOptions {
        business_connection_id?: string;
        currency: string;
        description: string;
        is_flexible?: boolean;
        max_tip_amount?: 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[];
        provider_data?: string;
        provider_token?: string;
        send_email_to_provider?: boolean;
        send_phone_number_to_provider?: boolean;
        subscription_period?: number;
        suggested_tip_amounts?: number[];
        title: string;
    }
    Index
    business_connection_id? currency description is_flexible? max_tip_amount? need_email? need_name? need_phone_number? need_shipping_address? payload photo_height? photo_size? photo_url? photo_width? prices provider_data? provider_token? send_email_to_provider? send_phone_number_to_provider? subscription_period? suggested_tip_amounts? title
    business_connection_id?: string

    Unique identifier of the business connection on behalf of which the link will be created.

    currency: string

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

    description: string

    Product description, 1-255 characters.

    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.

    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.

    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.

    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.

    subscription_period?: number

    Subscription period in seconds for recurring payments; must be one of 86400, 604800, 2592000, 6048000, 31536000.

    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