Hide navigation sidebar
Hide table of contents sidebar
PTB has undergone significant changes in v20. Please read the documentation carefully and also check out the transition guide in the wiki.
Back to top
Toggle table of contents sidebar

# Invoice

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

  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.

  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.

    - 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

    Product name.

    Type:

      `str`

  description

    Product description.

    Type:

      `str`

  start_parameter

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

    Type:

      `str`

  currency

    Three-letter ISO 4217 currency code.

    Type:

      `str`

  total_amount

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

    Type:

      `int`

  Available In

  - `telegram.ExternalReplyInfo.invoice`

  - `telegram.Message.invoice`

  MAX_DESCRIPTION_LENGTH = 255

    `telegram.constants.InvoiceLimit.MAX_DESCRIPTION_LENGTH`

    New in version 20.0.

  MAX_PAYLOAD_LENGTH = 128

    `telegram.constants.InvoiceLimit.MAX_PAYLOAD_LENGTH`

    New in version 20.0.

  MAX_TIP_AMOUNTS = 4

    `telegram.constants.InvoiceLimit.MAX_TIP_AMOUNTS`

    New in version 20.0.

  MAX_TITLE_LENGTH = 32

    `telegram.constants.InvoiceLimit.MAX_TITLE_LENGTH`

    New in version 20.0.

  MIN_DESCRIPTION_LENGTH = 1

    `telegram.constants.InvoiceLimit.MIN_DESCRIPTION_LENGTH`

    New in version 20.0.

  MIN_PAYLOAD_LENGTH = 1

    `telegram.constants.InvoiceLimit.MIN_PAYLOAD_LENGTH`

    New in version 20.0.

  MIN_TITLE_LENGTH = 1

    `telegram.constants.InvoiceLimit.MIN_TITLE_LENGTH`

    New in version 20.0.