InputInvoiceMessageContent

class telegram.InputInvoiceMessageContent(title, description, payload, provider_token, currency, prices, max_tip_amount=None, suggested_tip_amounts=None, provider_data=None, photo_url=None, photo_size=None, photo_width=None, photo_height=None, need_name=None, need_phone_number=None, need_email=None, need_shipping_address=None, send_phone_number_to_provider=None, send_email_to_provider=None, is_flexible=None, *, api_kwargs=None)[source]

Bases: telegram.InputMessageContent

Represents the content of a invoice message to be sent as the result of an inline query.

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

Available In

Added in version 13.5.

Parameters:

  • 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 it for your internal processes.

  • provider_token (str) –

    Payment provider token, obtained via @Botfather. Pass an empty string for payments in Telegram Stars.

    Deprecated since version 21.3: As of Bot API 7.4, this parameter is now optional and future versions of the library will make it optional as well.

  • currency (str) – Three-letter ISO 4217 currency code, see more on currencies. Pass XTR for payments in Telegram Stars.

  • prices (Sequence[telegram.LabeledPrice]) –

    Price breakdown, a 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.

    Changed in version 20.0: Accepts any collections.abc.Sequence as input instead of just a list. The input is converted to a tuple.

  • max_tip_amount (int, 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 (Sequence[int], optional) –

    An array of suggested amounts of tip 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.

    Changed in version 20.0:

    • This attribute is now an immutable tuple.

    • This attribute is now always a tuple, that may be empty.

  • provider_data (str, optional) – An object for data about the invoice, which will be shared with the payment provider. A detailed description of the required fields should be provided by the payment provider.

  • photo_url (str, optional) – 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 (int, optional) – Photo size.

  • photo_width (int, optional) – Photo width.

  • photo_height (int, optional) – Photo height.

  • need_name (bool, optional) – Pass True, if you require the user’s full name to complete the order. Ignored for payments in Telegram Stars.

  • need_phone_number (bool, optional) – Pass True, if you require the user’s phone number to complete the order. Ignored for payments in Telegram Stars.

  • need_email (bool, optional) – Pass True, if you require the user’s email address to complete the order. Ignored for payments in Telegram Stars.

  • need_shipping_address (bool, 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 (bool, optional) – Pass True, if user’s phone number should be sent to provider. Ignored for payments in Telegram Stars.

  • send_email_to_provider (bool, optional) – Pass True, if user’s email address should be sent to provider. Ignored for payments in Telegram Stars.

  • is_flexible (bool, optional) – Pass True, if the final price depends on the shipping method. Ignored for payments in Telegram Stars.

title[source]

Product name. 1- 32 characters.

Type:

str

description[source]

Product description. 1- 255 characters.

Type:

str

payload[source]

Bot-defined invoice payload. 1- 128 bytes. This will not be displayed to the user, use it for your internal processes.

Type:

str

provider_token[source]

Payment provider token, obtained via @Botfather. Pass an empty string for payments in Telegram Stars.

Type:

str

currency[source]

Three-letter ISO 4217 currency code, see more on currencies. Pass XTR for payments in Telegram Stars.

Type:

str

prices[source]

Price breakdown, a 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.

Changed in version 20.0: This attribute is now an immutable tuple.

Type:

Tuple[telegram.LabeledPrice]

max_tip_amount[source]

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 max_tip_amount is 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.

Type:

int

suggested_tip_amounts[source]

Optional. An array of suggested amounts of tip 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.

Changed in version 20.0: This attribute is now an immutable tuple.

Type:

Tuple[int]

provider_data[source]

Optional. An object for data about the invoice, which will be shared with the payment provider. A detailed description of the required fields should be provided by the payment provider.

Type:

str

photo_url[source]

Optional. 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.

Type:

str

photo_size[source]

Optional. Photo size.

Type:

int

photo_width[source]

Optional. Photo width.

Type:

int

photo_height[source]

Optional. Photo height.

Type:

int

need_name[source]

Optional. Pass True, if you require the user’s full name to complete the order. Ignored for payments in Telegram Stars.

Type:

bool

need_phone_number[source]

Optional. Pass True, if you require the user’s phone number to complete the order. Ignored for payments in Telegram Stars.

Type:

bool

need_email[source]

Optional. Pass True, if you require the user’s email address to complete the order. Ignored for payments in Telegram Stars.

Type:

bool

need_shipping_address[source]

Optional. Pass True, if you require the user’s shipping address to complete the order. Ignored for payments in Telegram Stars.

Type:

bool

send_phone_number_to_provider[source]

Optional. Pass True, if user’s phone number should be sent to provider. Ignored for payments in Telegram Stars.

Type:

bool

send_email_to_provider[source]

Optional. Pass True, if user’s email address should be sent to provider. Ignored for payments in Telegram Stars.

Type:

bool

is_flexible[source]

Optional. Pass True, if the final price depends on the shipping method. Ignored for payments in Telegram Stars.

Type:

bool

classmethod de_json(data, bot=None)[source]

See telegram.TelegramObject.de_json().