createInvoiceLink#
Returns: str
- class aiogram.methods.create_invoice_link.CreateInvoiceLink(*, title: str, description: str, payload: str, provider_token: str, currency: str, prices: List[LabeledPrice], max_tip_amount: Optional[int] = None, suggested_tip_amounts: Optional[List[int]] = None, provider_data: Optional[str] = None, photo_url: Optional[str] = None, photo_size: Optional[int] = None, photo_width: Optional[int] = None, photo_height: Optional[int] = None, need_name: Optional[bool] = None, need_phone_number: Optional[bool] = None, need_email: Optional[bool] = None, need_shipping_address: Optional[bool] = None, send_phone_number_to_provider: Optional[bool] = None, send_email_to_provider: Optional[bool] = None, is_flexible: Optional[bool] = None, **extra_data: Any)[source]#
Use this method to create a link for an invoice. Returns the created invoice link as String on success.
Source: https://core.telegram.org/bots/api#createinvoicelink
- title: str#
Product name, 1-32 characters
- description: str#
Product description, 1-255 characters
- payload: str#
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
- prices: List[LabeledPrice]#
Price breakdown, a JSON-serialized list of components (e.g. product price, tax, discount, delivery cost, delivery tax, bonus, etc.)
- max_tip_amount: Optional[int]#
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
passmax_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
- suggested_tip_amounts: Optional[List[int]]#
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: Optional[str]#
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: Optional[str]#
URL of the product photo for the invoice. Can be a photo of the goods or a marketing image for a service.
- photo_size: Optional[int]#
Photo size in bytes
- photo_width: Optional[int]#
Photo width
- photo_height: Optional[int]#
Photo height
- need_name: Optional[bool]#
Pass
True
if you require the user’s full name to complete the order
- need_phone_number: Optional[bool]#
Pass
True
if you require the user’s phone number to complete the order
- need_email: Optional[bool]#
Pass
True
if you require the user’s email address to complete the order
- need_shipping_address: Optional[bool]#
Pass
True
if you require the user’s shipping address to complete the order
- send_phone_number_to_provider: Optional[bool]#
Pass
True
if the user’s phone number should be sent to the provider
- send_email_to_provider: Optional[bool]#
Pass
True
if the user’s email address should be sent to the provider
- is_flexible: Optional[bool]#
Pass
True
if the final price depends on the shipping method
Usage#
As bot method#
result: str = await bot.create_invoice_link(...)
Method as object#
Imports:
from aiogram.methods.create_invoice_link import CreateInvoiceLink
alias:
from aiogram.methods import CreateInvoiceLink
With specific bot#
result: str = await bot(CreateInvoiceLink(...))
As reply into Webhook in handler#
return CreateInvoiceLink(...)