Telegram Bot API
🌐 English

createInvoiceLink

Category: Payments · Bot API 10.3 · Official documentation

Creates a payment link.

Returns: On success, returns String.

Parameters

ParameterTypeRequiredDescription
business_connection_idStringOptionalBusiness connection ID
titleStringYesProduct title
descriptionStringYesProduct description
payloadStringYesPayload
provider_tokenStringOptionalPayment provider token
currencyStringYesCurrency
pricesArray of LabeledPriceYesJSON LabeledPrice array
subscription_periodIntegerOptionalSubscription period in seconds
max_tip_amountIntegerOptionalMaximum tip amount
suggested_tip_amountsArray of IntegerOptionalJSON array of suggested tip amounts
provider_dataStringOptionalJSON data for provider
photo_urlStringOptionalProduct photo URL
photo_sizeIntegerOptionalPhoto size
photo_widthIntegerOptionalPhoto width
photo_heightIntegerOptionalPhoto height
need_nameBooleanOptionalRequest name
need_phone_numberBooleanOptionalRequest phone
need_emailBooleanOptionalRequest email
need_shipping_addressBooleanOptionalRequest shipping address
send_phone_number_to_providerBooleanOptionalSend phone to provider
send_email_to_providerBooleanOptionalSend email to provider
is_flexibleBooleanOptionalFlexible price

Parameter descriptions are concise summaries; see the official documentation for the full text.

Example request

curl

curl -s -X POST "https://api.telegram.org/bot$TOKEN/createInvoiceLink" \
  -H "Content-Type: application/json" \
  -d '{
  "title": "Example",
  "description": "Example item",
  "payload": "order-1",
  "currency": "XTR",
  "prices": [
    {
      "label": "Item",
      "amount": 100
    }
  ]
}'

Python

import requests

TOKEN = "123456789:AAEexampleTokenReplaceWithYours"
resp = requests.post(
    f"https://api.telegram.org/bot{TOKEN}/createInvoiceLink",
    json={
        "title": "Example",
        "description": "Example item",
        "payload": "order-1",
        "currency": "XTR",
        "prices": [
            {
                "label": "Item",
                "amount": 100
            }
        ]
    },
    timeout=30,
)
print(resp.json())

JavaScript

const TOKEN = "123456789:AAEexampleTokenReplaceWithYours";
const res = await fetch(`https://api.telegram.org/bot${TOKEN}/createInvoiceLink`, {
  method: "POST",
  headers: { "Content-Type": "application/json" },
  body: JSON.stringify({
    "title": "Example",
    "description": "Example item",
    "payload": "order-1",
    "currency": "XTR",
    "prices": [
      {
        "label": "Item",
        "amount": 100
      }
    ]
  }),
});
console.log(await res.json());

Step-by-step guide: How to Create a Telegram Bot: Step by Step with BotFather and Python