telegram.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, **_kwargs)
Bases:
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
andprices
are equal.New in version 13.5.
- Parameters:
title (
str
) – Product name, 1-32 charactersdescription (
str
) – Product description, 1-255 characterspayload (
str
) – Bot-defined invoice payload, 1-128 bytes. This will not be displayed to the user, use for your internal processes.provider_token (
str
) – Payment provider token, obtained via @Botfather.currency (
str
) – Three-letter ISO 4217 currency code, see more on currenciesprices (List[
telegram.LabeledPrice
]) – Price breakdown, a JSON-serialized list of components (e.g. product price, tax, discount, delivery cost, delivery tax, bonus, etc.)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 passmax_tip_amount = 145
. See theexp
parameter in currencies.json, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies). Defaults to0
.suggested_tip_amounts (List[
int
], optional) – A JSON-serialized 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 exceedmax_tip_amount
.provider_data (
str
, optional) – A JSON-serialized 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) – PassTrue
, if you require the user’s full name to complete the order.need_phone_number (
bool
, optional) – PassTrue
, if you require the user’s phone number to complete the orderneed_email (
bool
, optional) – PassTrue
, if you require the user’s email address to complete the order.need_shipping_address (
bool
, optional) – PassTrue
, if you require the user’s shipping address to complete the ordersend_phone_number_to_provider (
bool
, optional) – PassTrue
, if user’s phone number should be sent to provider.send_email_to_provider (
bool
, optional) – PassTrue
, if user’s email address should be sent to provider.is_flexible (
bool
, optional) – PassTrue
, if the final price depends on the shipping method.**kwargs (
dict
) – Arbitrary keyword arguments.
- title
Product name, 1-32 characters
- Type:
str
- description
Product description, 1-255 characters
- Type:
str
- payload
Bot-defined invoice payload, 1-128 bytes. This will not be displayed to the user, use for your internal processes.
- Type:
str
- provider_token
Payment provider token, obtained via @Botfather.
- Type:
str
- currency
Three-letter ISO 4217 currency code, see more on currencies
- Type:
str
- prices
Price breakdown, a JSON-serialized list of components.
- Type:
List[
telegram.LabeledPrice
]
- max_tip_amount
Optional. The maximum accepted amount for tips in the smallest units of the currency (integer, not float/double).
- Type:
int
- suggested_tip_amounts
Optional. A JSON-serialized array of suggested amounts of tip in the smallest units of the currency (integer, not float/double).
- Type:
List[
int
]
- provider_data
Optional. A JSON-serialized object for data about the invoice, which will be shared with the payment provider.
- Type:
str
- photo_url
Optional. URL of the product photo for the invoice.
- Type:
str
- photo_size
Optional. Photo size.
- Type:
int
- photo_width
Optional. Photo width.
- Type:
int
- photo_height
Optional. Photo height.
- Type:
int
- need_name
Optional. Pass
True
, if you require the user’s full name to complete the order.- Type:
bool
- need_phone_number
Optional. Pass
True
, if you require the user’s phone number to complete the order- Type:
bool
- need_email
Optional. Pass
True
, if you require the user’s email address to complete the order.- Type:
bool
- need_shipping_address
Optional. Pass
True
, if you require the user’s shipping address to complete the order- Type:
bool
- send_phone_number_to_provider
Optional. Pass
True
, if user’s phone number should be sent to provider.- Type:
bool
- send_email_to_provider
Optional. Pass
True
, if user’s email address should be sent to provider.- Type:
bool
- is_flexible
Optional. Pass
True
, if the final price depends on the shipping method.- Type:
bool
- classmethod de_json(data, bot)
- to_dict()