Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Index

Properties

currency: string

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

description: string

Product description, 1-255 characters

disableNotification?: boolean

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

isFlexible?: boolean

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

needEmail?: boolean

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

needName?: boolean

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

needPhoneNumber?: boolean

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

needShippingAddress?: 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.

photoHeight?: number

Photo height

photoSize?: number

Photo size

photoUrl?: 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.

photoWidth?: number

Photo width

prices: { amount: number; label: string }[]

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

providerData?: string | object

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

providerToken: string

Payments provider token, obtained via Botfather

replyMarkup?: SociablyNode

One ReplyMarkup element for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user.

replyToMessageId?: number

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

sendEmailToProvider?: boolean

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

sendPhoneNumberToProvider?: boolean

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

startParameter: string

Unique deep-linking parameter that can be used to generate this invoice when used as a start parameter

title: string

Product name, 1-32 characters

Generated using TypeDoc