Interface ISendInvoiceParams

Parameters for the sendInvoice method

Hierarchy

  • ISendInvoiceParams

Properties

allow_sending_without_reply?: boolean

Pass True if the message should be sent even if the specified replied-to message is not found

chat_id: string | number

Unique identifier for the target chat or username of the target channel (in the format @channelusername)

currency: string

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

description: string

Product description, 1-255 characters

disable_notification?: boolean

Sends the message silently. Users will receive a notification with no sound.

is_flexible?: boolean

Pass True if the final price depends on the shipping method

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

message_thread_id?: number

Unique identifier for the target message thread (topic) of the forum; for forum supergroups only

need_email?: boolean

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

need_name?: boolean

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

need_phone_number?: boolean

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

need_shipping_address?: boolean

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

Photo height

photo_size?: number

Photo size in bytes

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. People like it better when they see what they are paying for.

photo_width?: number

Photo width

prices: ILabeledPrice[]

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

protect_content?: boolean

Protects the contents of the sent message from forwarding and saving

provider_data?: string

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

provider_token: string

Payment provider token, obtained via

Bot Father

reply_markup?: IInlineKeyboardMarkup

A JSON-serialized object for an inline keyboard. If empty, one 'Pay total price' button will be shown. If not empty, the first button must be a Pay button.

reply_to_message_id?: number

If the message is a reply, ID of the original message

send_email_to_provider?: boolean

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

send_phone_number_to_provider?: boolean

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

start_parameter?: string

Unique deep-linking parameter. If left empty, forwarded copies of the sent message will have a Pay button, allowing multiple users to pay directly from the forwarded message, using the same invoice. If non-empty, forwarded copies of the sent message will have a URL button with a deep link to the bot (instead of a Pay button), with the value used as the start parameter

suggested_tip_amounts?: number[]

A JSON-serialized array 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.

title: string

Product name, 1-32 characters

Generated using TypeDoc