Go to Latest
interface InputInvoiceMessageContent
import { type InputInvoiceMessageContent } from "https://deno.land/x/grammy@v1.10.1/types.ts";

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

Properties

title: string

Product name, 1-32 characters

description: string

Product description, 1-255 characters

payload: string

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

provider_token: string

Payment provider token, obtained via BotFather

currency: string

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

prices: LabeledPrice[]

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

optional
max_tip_amount: number

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

optional
suggested_tip_amounts: number[]

An 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.

optional
provider_data: string

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.

optional
photo_url: string

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

optional
photo_size: number

Photo size in bytes

optional
photo_width: number

Photo width

optional
photo_height: number

Photo height

optional
need_name: boolean

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

optional
need_phone_number: boolean

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

optional
need_email: boolean

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

optional
need_shipping_address: boolean

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

optional
send_phone_number_to_provider: boolean

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

optional
send_email_to_provider: boolean

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

optional
is_flexible: boolean

Pass True, if the final price depends on the shipping method