Skip to main content
Module

x/grammy/core/api.ts>Api#sendInvoice

The Telegram Bot Framework.
Extremely Popular
Go to Latest
method Api.prototype.sendInvoice
import { Api } from "https://deno.land/x/grammy@v1.11.1/core/api.ts";

Use this method to send invoices. On success, the sent Message is returned.

Parameters

chat_id: number | string

Unique identifier for the target chat or username of the target channel (in the format @channelusername)

title: string

Product name, 1-32 characters

description: string

Product description, 1-255 characters

payload: string

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

provider_token: string

Payments provider token, obtained via BotFather

currency: string

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

prices: readonly LabeledPrice[]

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

optional
other: Other<R, "sendInvoice",
| "chat_id"
| "title"
| "description"
| "payload"
| "provider_token"
| "currency"
| "prices"
>

Optional remaining parameters, confer the official reference below

optional
signal: AbortSignal

Optional AbortSignal to cancel the request

Official reference: https://core.telegram.org/bots/api#sendinvoice