Options
All
  • Public
  • Public/Protected
  • All
Menu

Send Invoice API Payload.

Hierarchy

  • ISendInvoicePayload

Index

Properties

chat_id

chat_id: number

Unique identifier for the target private chat.

currency

currency: string

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

description

description: string

Product description, 1-255 characters.

Optional disable_notification

disable_notification: boolean

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

Optional is_flexible

is_flexible: boolean

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

Optional need_email

need_email: boolean

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

Optional need_name

need_name: boolean

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

Optional need_phone_number

need_phone_number: boolean

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

Optional need_shipping_address

need_shipping_address: boolean

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

payload

payload: string

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

Optional photo_height

photo_height: number

Photo height.

Optional photo_size

photo_size: number

Photo size.

Optional photo_url

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.

Optional photo_width

photo_width: number

Photo width.

prices

prices: ILabeledPrice[]

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

provider_token

provider_token: string

Payments provider token, obtained via Botfather.

Optional reply_markup

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.

Optional reply_to_message_id

reply_to_message_id: number

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

start_parameter

start_parameter: string

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

title

title: string

Product name, 1-32 characters.

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method

Generated using TypeDoc