createInvoiceLink()

Use this method to create a link for an invoice. Returns the created invoice link as String on success.

parameters

parameter	type	required	description
`business_connection_id`	string	optional	Unique identifier of the business connection on behalf of which the link will be created. For payments in Telegram Stars only.
`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.
`provider_token`	string	optional	Payment provider token, obtained via @BotFather. Pass an empty string for payments in Telegram Stars.
`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.
`subscription_period`	number	optional	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	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`	number[]	optional	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	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`	string	optional	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	optional	Photo size in bytes
`photo_width`	number	optional	Photo width
`photo_height`	number	optional	Photo height
`need_name`	boolean	optional	Pass True if you require the user's full name to complete the order. Ignored for payments in Telegram Stars.
`need_phone_number`	boolean	optional	Pass True if you require the user's phone number to complete the order. Ignored for payments in Telegram Stars.
`need_email`	boolean	optional	Pass True if you require the user's email address to complete the order. Ignored for payments in Telegram Stars.
`need_shipping_address`	boolean	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`	boolean	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`	boolean	optional	Pass True if the user's email address should be sent to the provider. Ignored for payments in Telegram Stars.
`is_flexible`	boolean	optional	Pass True if the final price depends on the shipping method. Ignored for payments in Telegram Stars.

returns

string

usage in yaebal

not (yet) hard-typed on Api — call it through the generic .call<T>() escape hatch documented in @yaebal/types.

bot.ts

import type { CreateInvoiceLinkParams } from "@yaebal/types";

await bot.api.call<string>("createInvoiceLink", {
  title: "...",
  description: "...",
  payload: "...",
  currency: "...",
  prices: [],
} satisfies CreateInvoiceLinkParams);

official Bot API docs: https://core.telegram.org/bots/api/#createinvoicelink