Invoice
Constructor schema is available as of layer 127. Switch »| Name | Type | Description |
|---|---|---|
| flags | # | Flags, see TL conditional fields |
| test | flags.0?true | Test invoice |
| name_requested | flags.1?true | Set this flag if you require the user's full name to complete the order |
| phone_requested | flags.2?true | Set this flag if you require the user's phone number to complete the order |
| email_requested | flags.3?true | Set this flag if you require the user's email address to complete the order |
| shipping_address_requested | flags.4?true | Set this flag if you require the user's shipping address to complete the order |
| flexible | flags.5?true | Set this flag if the final price depends on the shipping method |
| phone_to_provider | flags.6?true | Set this flag if user's phone number should be sent to provider |
| email_to_provider | flags.7?true | Set this flag if user's email address should be sent to provider |
| recurring | flags.9?true | Whether this is a recurring payment |
| currency | string | Three-letter ISO 4217 currency code, or XTR for Telegram Stars. |
| prices | Vector<LabeledPrice> | Price breakdown, a list of components (e.g. product price, tax, discount, delivery cost, delivery tax, bonus, etc.) |
| max_tip_amount | flags.8?long | 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 | flags.8?Vector<long> | 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 | flags.10?string | Terms of service URL |
| subscription_period | flags.11?int |
Telegram Stars are virtual items that allow users to purchase digital goods and services from bots and mini apps inside the Telegram ecosystem, send gifts to content creators on the Telegram platform, and more.