Invoice¶

class telegram.Invoice(title, description, start_parameter, currency, total_amount, *, api_kwargs=None)[source]¶

Bases: telegram.TelegramObject

This object contains basic information about an invoice.

Objects of this class are comparable in terms of equality. Two objects of this class are considered equal, if their title, description, start_parameter, currency and total_amount are equal.

Available In

Parameters:

title (str) – Product name.
description (str) – Product description.
start_parameter (str) – Unique bot deep-linking parameter that can be used to generate this invoice.
currency (str) – Three-letter ISO 4217 currency code, or XTR for payments in Telegram Stars.
total_amount (int) – Total price in the smallest units of the currency (integer, not float/double). For example, for a price of US$ 1.45 pass 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).

title[source]¶

Product name.

Type:: str

description[source]¶

Product description.

Type:: str

start_parameter[source]¶

Unique bot deep-linking parameter that can be used to generate this invoice.

Type:: str

currency[source]¶

Three-letter ISO 4217 currency code, or XTR for payments in Telegram Stars.

Type:: str

total_amount[source]¶

Total price in the smallest units of the currency (integer, not float/double). For example, for a price of US$ 1.45 pass 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).

Type:: int

MAX_DESCRIPTION_LENGTH = 255[source]¶: telegram.constants.InvoiceLimit.MAX_DESCRIPTION_LENGTH

Added in version 20.0.

MAX_PAYLOAD_LENGTH = 128[source]¶: telegram.constants.InvoiceLimit.MAX_PAYLOAD_LENGTH

Added in version 20.0.

MAX_TIP_AMOUNTS = 4[source]¶: telegram.constants.InvoiceLimit.MAX_TIP_AMOUNTS

Added in version 20.0.

MAX_TITLE_LENGTH = 32[source]¶: telegram.constants.InvoiceLimit.MAX_TITLE_LENGTH

Added in version 20.0.

MIN_DESCRIPTION_LENGTH = 1[source]¶: telegram.constants.InvoiceLimit.MIN_DESCRIPTION_LENGTH

Added in version 20.0.

MIN_PAYLOAD_LENGTH = 1[source]¶: telegram.constants.InvoiceLimit.MIN_PAYLOAD_LENGTH

Added in version 20.0.

MIN_TITLE_LENGTH = 1[source]¶: telegram.constants.InvoiceLimit.MIN_TITLE_LENGTH

Added in version 20.0.