Interface IInputInvoiceMessageContent

Represents the content of an invoice message to be sent as the result of an inline query.

Hierarchy

  • IInputInvoiceMessageContent

Properties

currency: string

Three-letter ISO 4217 currency code, see more on currencies

description: string

Product description, 1-255 characters

is_flexible?: boolean

Optional. Pass True if the final price depends on the shipping method

max_tip_amount?: number

Optional. The maximum accepted amount for tips in the smallest units of the currency (integer, not float/double). For example, for a maximum tip of US$ 1.45 pass max_tip_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). Defaults to 0

need_email?: boolean

Optional. Pass True if you require the user's email address to complete the order

need_name?: boolean

Optional. Pass True if you require the user's full name to complete the order

need_phone_number?: boolean

Optional. Pass True if you require the user's phone number to complete the order

need_shipping_address?: boolean

Optional. Pass True if you require the user's shipping address to complete the order

payload: string

Bot-defined invoice payload, 1-128 bytes. This will not be displayed to the user, use for your internal processes.

photo_height?: number

Optional. Photo height

photo_size?: number

Optional. Photo size in bytes

photo_url?: string

Optional. URL of the product photo for the invoice. Can be a photo of the goods or a marketing image for a service.

photo_width?: number

Optional. Photo width

prices: ILabeledPrice[]

Price breakdown, a JSON-serialized list of components (e.g. product price, tax, discount, delivery cost, delivery tax, bonus, etc.)

provider_data?: string

Optional. A JSON-serialized object for data about the invoice, which will be shared with the payment provider. A detailed description of the required fields should be provided by the payment provider.

provider_token: string

Payment provider token, obtained via

Bot Father

send_email_to_provider?: boolean

Optional. Pass True if the user's email address should be sent to provider

send_phone_number_to_provider?: boolean

Optional. Pass True if the user's phone number should be sent to provider

suggested_tip_amounts?: number[]

Optional. A JSON-serialized array of suggested amounts of tip 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.

title: string

Product name, 1-32 characters

Generated using TypeDoc