sendInvoice
Use this method to send invoices.
Required: chat_id, title, description, payload, currency, prices · Optional: 25 parameters
Limits:
- title: 1-32 characters
- description: 1-255 characters
- allow_paid_broadcast: up to 1000 messages
Try it
TypeScript example · @effect-ak/tg-bot-client
import { makeTgBotClient } from "@effect-ak/tg-bot-client"
const client = makeTgBotClient({ bot_token: "YOUR_BOT_TOKEN" })
const result = await client.execute("send_invoice", { chat_id: "YOUR_CHAT_ID", title: "...", description: "...", payload: "...", currency: "...", prices: []})Parameters
chat_id number | string Required
Unique identifier for the target chat or username of the target channel (in the format @channelusername).
title string Required
Product name, 1-32 characters.
description string Required
Product description, 1-255 characters.
payload string Required
Bot-defined invoice payload, 1-128 bytes. This will not be displayed to the user, use it for your internal processes.
currency string Required
Three-letter ISO 4217 currency code, see more on currencies. Pass “XTR” for payments in Telegram Stars.
prices LabeledPrice[] Required
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 number
Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only.
direct_messages_topic_id number
Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat.
provider_token string
Payment provider token, obtained via @BotFather. Pass an empty string for payments in Telegram Stars.
max_tip_amount number
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 number[]
A JSON-serialized 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 string
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 string
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 string
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 number
Photo size in bytes.
photo_width number
Photo width.
photo_height number
Photo height.
need_name boolean
Pass True if you require the user’s full name to complete the order. Ignored for payments in Telegram Stars.
need_phone_number boolean
Pass True if you require the user’s phone number to complete the order. Ignored for payments in Telegram Stars.
need_email boolean
Pass True if you require the user’s email address to complete the order. Ignored for payments in Telegram Stars.
need_shipping_address boolean
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 boolean
Pass True if the user’s phone number should be sent to the provider. Ignored for payments in Telegram Stars.
send_email_to_provider boolean
Pass True if the user’s email address should be sent to the provider. Ignored for payments in Telegram Stars.
is_flexible boolean
Pass True if the final price depends on the shipping method. Ignored for payments in Telegram Stars.
disable_notification boolean
Sends the message silently. Users will receive a notification with no sound.
protect_content boolean
Protects the contents of the sent message from forwarding and saving.
allow_paid_broadcast boolean
Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot’s balance.
message_effect_id string
Unique identifier of the message effect to be added to the message; for private chats only.
suggested_post_parameters SuggestedPostParameters
A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.
reply_parameters ReplyParameters
Description of the message to reply to.
reply_markup InlineKeyboardMarkup
A JSON-serialized object for an inline keyboard. If empty, one ‘Pay total price’ button will be shown. If not empty, the first button must be a Pay button.
Related methods
sendAnimation · sendAudio · sendChatAction · sendChecklist · sendContact · sendDice · sendDocument · sendGame · sendGift · sendLocation · sendMediaGroup · sendMessage · sendMessageDraft · sendPaidMedia · sendPhoto · sendPoll · sendSticker · sendVenue · sendVideo · sendVideoNote · sendVoice