Class Invoice

constructor

• new Invoice(raw, _extendedMedia?): Invoice

• Parameters

  • raw: RawMessageMediaInvoice
  • Optional_extendedMedia: MessageMedia

  Returns Invoice

Readonlyraw

Readonlytype

amount

• get amount(): Long

• Total price in the smallest units of the currency (integer, not float/double). For example, for a price of US$ 1.45 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).

  Returns Long

currency

• get currency(): string

• Three-letter ISO 4217 currency code

  Returns string

description

• get description(): string

• Product description, 1-255 characters

  Returns string

extendedMedia

• get extendedMedia(): MessageMedia

• Get the invoice's extended media. Only available if extendedMediaState is full. Otherwise, throws an error.

  Returns MessageMedia

extendedMediaPreview

• get extendedMediaPreview(): ExtendedMediaPreview

• Get the invoice's extended media preview. Only available if extendedMediaState is preview. Otherwise, throws an error.

  Returns ExtendedMediaPreview

extendedMediaState

• get extendedMediaState(): InvoiceExtendedMediaState

• If this invoice has extended media

  Returns InvoiceExtendedMediaState

inputMedia

• get inputMedia(): TypeInputMedia

• Input media TL object generated from this object, to be used inside InputMediaLike and TelegramClient.sendMedia.

  Invoice can't provide an input media, since some of the data is not available to the user, which is required to send it. This getter is only provided to allow using msg.media.inputMedia

  Returns TypeInputMedia

photo

• get photo(): null | WebDocument

• URL of the product photo for the invoice

  Returns null | WebDocument

receiptMessageId

• get receiptMessageId(): null | number

• Message ID of receipt

  Returns null | number

startParam

• get startParam(): string

• Unique bot deep-linking parameter that can be used to generate this invoice

  Returns string

title

• get title(): string

• Product name, 1-32 characters

  Returns string

isShippingAddressRequested

• isShippingAddressRequested(): boolean

• Whether the shipping address was requested

  Returns boolean

isTest

• isTest(): boolean

• Whether this is an example (test) invoice

  Returns boolean