Class Invoice

Hierarchy (View Summary)

Constructors

constructor

Properties

currency description startParameter title totalAmount

Accessors

client

Methods

_clone _patch _update create toJSON valueOf

Constructors

constructor

Properties

currency

currency: string

Three-letter ISO 4217 currency code, or “XTR” for payments in Telegram Stars

description

description: string

Product description

startParameter

startParameter: string

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

title

title: string

Product name

totalAmount

totalAmount: number

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

Accessors

client

Methods

Protected_clone

  • _clone(): Base
  • Protected

    Creates a clone of the current instance

    Returns Base

    A clone of the current instance

Protected_patch

  • _patch(data: Record<string, any>): Record<string, any>
  • Protected

    Patches the current instance with new data

    Parameters

    • data: Record<string, any>

      The data to patch the instance with

    Returns Record<string, any>

    The patched data

Protected_update

  • _update(data: Record<string, any>): Base
  • Protected

    Updates the current instance with new data and returns a clone of the updated instance

    Parameters

    • data: Record<string, any>

      The data to update the instance with

    Returns Base

    A clone of the updated instance

create

  • create(
        payload: string,
        prices: LabeledPrice[],
        options?: 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",
        >,
    ): 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.

toJSON

  • toJSON(
        propsRecursive?: boolean,
        ...props: Record<string, string | boolean>[],
    ): Record<string, any>

  • Flatten an object. Any properties that are collections will get converted to an array of keys.

    Parameters

    • OptionalpropsRecursive: boolean

      Optional. If true, calls toJSON method on nested objects.

    • ...props: Record<string, string | boolean>[]

      Optional. Specific properties to include/exclude, or rename.

    Returns Record<string, any>

    Flattened object.

valueOf

  • valueOf(): null | string

  • Returns the id instance Chat, User, ChatMember and other

    Returns null | string

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods