Class Invoice

constructor

• new Invoice(client, data): Invoice

• Parameters

  • client: TelegramClient | BaseClient

    The client that instantiated this
  • data: Invoice

    Data about the contains basic information about an invoice

  Returns Invoice

currency

description

startParameter

title

totalAmount

create

• create(payload, prices, options?): Promise<string>

• Use this method to create a link for an invoice.

  Parameters

  • payload: string

    Bot-defined invoice payload, 1-128 bytes. This will not be displayed to the user, use for your internal processes
  • prices: LabeledPrice[]

    Price breakdown, a list of components (e.g. product price, tax, discount, delivery cost, delivery tax, bonus, etc.)
  • Optionaloptions: Omit<{
        currency: string;
        description: string;
        isFlexible?: boolean;
        maxTipAmount?: number;
        needEmail?: boolean;
        needName?: boolean;
        needPhoneNumber?: boolean;
        needShippingAddress?: boolean;
        payload: string;
        photoHeight?: number;
        photoSize?: number;
        photoUrl?: string;
        photoWidth?: number;
        prices: LabeledPrice[];
        providerData?: string;
        providerToken?: string;
        sendEmailToProvider?: boolean;
        sendPhoneNumberToProvider?: boolean;
        suggestedTipAmounts?: number[];
        title: string;
    },
        | "currency"
        | "description"
        | "title"
        | "payload"
        | "prices"
        | "maxTipAmount">

    out parameters

  Returns Promise<string>

  Returns the created invoice link as String on success.