Invoice

class pyrogram.raw.types.Invoice

Invoice

Constructor of Invoice.

Details:

  • Layer: 223

  • ID: 49EE584

Parameters:

  • currency (str) – Three-letter ISO 4217 currency code, or XTR for Telegram Stars.

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

  • test (bool, optional) – Test invoice

  • name_requested (bool, optional) – Set this flag if you require the user’s full name to complete the order

  • phone_requested (bool, optional) – Set this flag if you require the user’s phone number to complete the order

  • email_requested (bool, optional) – Set this flag if you require the user’s email address to complete the order

  • shipping_address_requested (bool, optional) – Set this flag if you require the user’s shipping address to complete the order

  • flexible (bool, optional) – Set this flag if the final price depends on the shipping method

  • phone_to_provider (bool, optional) – Set this flag if user’s phone number should be sent to provider

  • email_to_provider (bool, optional) – Set this flag if user’s email address should be sent to provider

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

  • max_tip_amount (int 64-bit, 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 64-bit, 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

  • subscription_period (int 32-bit, optional) – The number of seconds between consecutive Telegram Star debiting for bot subscription invoices

TL Schema

invoice#49ee584
flags:#
test:flags.0?true
name_requested:flags.1?true
phone_requested:flags.2?true
email_requested:flags.3?true
shipping_address_requested:flags.4?true
flexible:flags.5?true
phone_to_provider:flags.6?true
email_to_provider:flags.7?true
recurring:flags.9?true
currency:string
prices:Vector<LabeledPrice>
max_tip_amount:flags.8?long
suggested_tip_amounts:flags.8?Vector<long>
terms_url:flags.10?string
subscription_period:flags.11?int

= Invoice

Parameter Tree

Invoice
├── test → true (optional)
├── name_requested → true (optional)
├── phone_requested → true (optional)
├── email_requested → true (optional)
├── shipping_address_requested → true (optional)
├── flexible → true (optional)
├── phone_to_provider → true (optional)
├── email_to_provider → true (optional)
├── recurring → true (optional)
├── currency → string
├── prices → Vector < LabeledPrice >
│ └── LabeledPrice
│ ├── label → string
│ └── amount → long
├── max_tip_amount → long (optional)
├── suggested_tip_amounts → Vector < long > (optional)
├── terms_url → string (optional)
└── subscription_period → int (optional)

Example

Invoice(
    currency="text",
    prices=[
            LabeledPrice(
                label="text",
                amount=0
            )
        ],
)