Invoice

class pyrogram.types.Invoice

This object contains basic information about an invoice.

Parameters:

  • currency (str) – Three-letter ISO 4217 currency code.

  • is_test (bool) – True, if the invoice is a test invoice.

  • title (str, optional) – Product name.

  • description (str, optional) – Product description.

  • total_amount (int, optional) – 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).

  • start_parameter (str, optional) – Unique bot deep-linking parameter that can be used to generate this invoice.

  • prices (List of LabeledPrice, optional) – Price breakdown, a list of components (e.g. product price, tax, discount, delivery cost, delivery tax, bonus, etc.).

  • is_name_requested (bool, optional) – True, if the name should be specified.

  • is_phone_requested (bool, optional) – True, if the phone should be specified.

  • is_email_requested (bool, optional) – True, if the email address should be specified.

  • is_shipping_address_requested (bool, optional) – True, if the shipping address should be specified.

  • is_flexible (bool, optional) – True, if the final price depends on the shipping method.

  • is_phone_to_provider (bool, optional) – True, if user’s phone should be sent to provider.

  • is_email_to_provider (bool, optional) – True, if user’s email address should be sent to provider.

  • is_recurring (bool, optional) – Whether this is a recurring payment.

  • 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 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).

  • suggested_tip_amounts (List of int, optional) – A vector 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.

  • terms_url (str, optional) – Terms of service URL.

  • raw (MessageMediaInvoice | Invoice, optional) – The raw object, as received from the Telegram API.