send_invoice()#

Client.send_invoice()#

Use this method to send invoices.

Usable by ❌ Users ✅ Bots
Parameters:

  • chat_id (int | str) – Unique identifier (int) or username (str) of the target chat.

  • title (str) – Product name, 1-32 characters.

  • description (str) – Product description, 1-255 characters

  • payload (str | bytes) – Bot-defined invoice payload, 1-128 bytes. This will not be displayed to the user, use for your internal processes.

  • currency (str) – Three-letter ISO 4217 currency code, see more on currencies. Pass XTR for payments in Telegram Stars.

  • prices (List of LabeledPrice) – Price breakdown, a JSON-serialized list of components (e.g. product price, tax, discount, delivery cost, delivery tax, bonus, etc.). Must contain exactly one item for payments in Telegram Stars.

  • message_thread_id (int, optional) – If the message is in a thread, ID of the original message.

  • provider_token (str, optional) – Payment provider token, obtained via @BotFather. Pass an empty string for payments in Telegram Stars.

  • max_tip_amount (int, optional) – The maximum accepted amount for tips in the smallest units of the currency (integer, not float/double). For example, for a maximum tip of US$ 1.45 pass max_tip_amount = 145. See the exp parameter in currencies.json, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies). Defaults to 0. Not supported for payments in Telegram Stars.

  • suggested_tip_amounts (List of int, optional) – An array of suggested amounts of tips in the smallest units of the currency (integer, not float/double). At most 4 suggested tip amounts can be specified. The suggested tip amounts must be positive, passed in a strictly increased order and must not exceed max_tip_amount.

  • start_parameter (str, optional) – Unique deep-linking parameter. If left empty, forwarded copies of the sent message will have a Pay button, allowing multiple users to pay directly from the forwarded message, using the same invoice. If non-empty, forwarded copies of the sent message will have a URL button with a deep link to the bot (instead of a Pay button), with the value used as the start parameter.

  • provider_data (str, optional) – JSON-serialized data about the invoice, which will be shared with the payment provider. A detailed description of required fields should be provided by the payment provider.

  • photo_url (str, optional) – URL of the product photo for the invoice. Can be a photo of the goods or a marketing image for a service. People like it better when they see what they are paying for.

  • photo_size (int, optional) – Photo size in bytes

  • photo_width (int, optional) – Photo width

  • photo_height (int, optional) – Photo height

  • need_name (bool, optional) – Pass True if you require the user’s full name to complete the order. Ignored for payments in Telegram Stars.

  • need_phone_number (bool, optional) – Pass True if you require the user’s phone number to complete the order. Ignored for payments in Telegram Stars.

  • need_email (bool, optional) – Pass True if you require the user’s email address to complete the order. Ignored for payments in Telegram Stars.

  • need_shipping_address (bool, optional) – Pass True if you require the user’s shipping address to complete the order. Ignored for payments in Telegram Stars.

  • send_phone_number_to_provider (bool, optional) – Pass True if the user’s phone number should be sent to the provider. Ignored for payments in Telegram Stars.

  • send_email_to_provider (bool, optional) – Pass True if the user’s email address should be sent to the provider. Ignored for payments in Telegram Stars.

  • is_flexible (bool, optional) – Pass True if the final price depends on the shipping method. Ignored for payments in Telegram Stars.

  • disable_notification (bool, optional) – Sends the message silently. Users will receive a notification with no sound.

  • protect_content (bool, optional) – Pass True if the content of the message must be protected from forwarding and saving; for bots only.

  • message_effect_id (int 64-bit, optional) – Unique identifier of the message effect to be added to the message; for private chats only.

  • reply_parameters (ReplyParameters, optional) – Description of the message to reply to

  • reply_markup (InlineKeyboardMarkup | ReplyKeyboardMarkup | ReplyKeyboardRemove | ForceReply, optional) – Additional interface options. An object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user.

  • caption (str, optional) – Document caption, 0-1024 characters.

  • parse_mode (ParseMode, optional) – By default, texts are parsed using both Markdown and HTML styles. You can combine both syntaxes together.

  • caption_entities (List of MessageEntity) – List of special entities that appear in the caption, which can be specified instead of parse_mode.

Returns:

Message – On success, the sent invoice message is returned.