Skip to main content

invoice

Invoice

type tg.Invoice struct { /* ... */ }

Fields​

NameTypeRequiredDescription
Testbool—Test invoice
NameRequestedbool—Set this flag if you require the user's full name to complete the order
PhoneRequestedbool—Set this flag if you require the user's phone number to complete the order
EmailRequestedbool—Set this flag if you require the user's email address to complete the order
ShippingAddressRequestedbool—Set this flag if you require the user's shipping address to complete the order
Flexiblebool—Set this flag if the final price depends on the shipping method
PhoneToProviderbool—Set this flag if user's phone number should be sent to provider
EmailToProviderbool—Set this flag if user's email address should be sent to provider
Recurringbool—Whether this is a recurring payment
CurrencystringyesThree-letter ISO 4217 currency code, or XTR for Telegram Stars.
Prices[]LabeledPriceyesPrice breakdown, a list of components (e.g. product price, tax, discount, delivery cost, delivery tax, bonus, etc.)
MaxTipAmountint64—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).
SuggestedTipAmounts[]int64—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.
TermsURLstring—Terms of service URL
SubscriptionPeriodint—The number of seconds between consecutive Telegram Star debiting for bot subscription invoices

References​