Documentation - v0.27.0
    Preparing search index...

    Interface InputMediaInvoice

    An invoice to be sent (see https://core.telegram.org/bots/payments)

    interface InputMediaInvoice {
        caption?: InputText;
        description: string;
        extendedMedia?: InputMediaLike;
        invoice: RawInvoice;
        payload: Uint8Array;
        photo?: string | RawInputWebDocument;
        providerData: unknown;
        startParam: string;
        title: string;
        token: string;
        type: "invoice";
    }

    Hierarchy (View Summary)

    Index

    Properties

    caption? description extendedMedia? invoice payload photo? providerData startParam title token type

    Properties

    caption?: InputText

    Caption of the media

    description: string

    Product description (1-255 chars)

    extendedMedia?: InputMediaLike

    Extended media (i.e. media that will be available once the invoice is paid)

    invoice: RawInvoice

    The invoice itself

    payload: Uint8Array

    Bot-defined invoice payload (1-128 bytes).

    Will not be displayed to the user and can be used for internal processes

    photo?: string | RawInputWebDocument

    Product photo. Can be a photo of the goods or a marketing image for a service.

    Can be a URL, or a TL object with input web document

    providerData: unknown

    Data about the invoice as a plain JS object, which will be shared with the payment provider. A detailed description of required fields should be provided by the payment provider.

    startParam: string

    Start parameter for the bot

    title: string

    Product name (1-32 chars)

    token: string

    Payments provider token, obtained from @BotFather

    type: "invoice"

    Settings

    Member Visibility

    On This Page

    Properties