createInvoiceLink
Returns string ↗
Use this method to create a link for an invoice.
Required: title, description, payload, currency, prices · Optional: 17 parameters
Limits:
- title: 1-32 characters
- description: 1-255 characters
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("create_invoice_link", { title: "...", description: "...", payload: "...", currency: "...", prices: []})Parameters
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.
business_connection_id string
Unique identifier of the business connection on behalf of which the link will be created. For payments in Telegram Stars only.
provider_token string
Payment provider token, obtained via @BotFather. Pass an empty string for payments in Telegram Stars.
subscription_period number
The number of seconds the subscription will be active for before the next payment. The currency must be set to “XTR” (Telegram Stars) if the parameter is used. Currently, it must always be 2592000 (30 days) if specified. Any number of subscriptions can be active for a given bot at the same time, including multiple concurrent subscriptions from the same user. Subscription price must no exceed 10000 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.
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.
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.
Related methods
createChatInviteLink · createChatSubscriptionInviteLink · createForumTopic · createNewStickerSet