Telegram Bot API
🌐 English

editUserStarSubscription

Category: Payments · Bot API 10.3 · Official documentation

Cancels or renews a Telegram Stars subscription.

Returns: On success, returns True.

Parameters

ParameterTypeRequiredDescription
user_idIntegerYesUser ID
telegram_payment_charge_idStringYesTelegram payment ID
is_canceledBooleanYestrue = cancel subscription extension, false = allow extension

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/editUserStarSubscription" \
  -H "Content-Type: application/json" \
  -d '{
  "user_id": 123456789,
  "telegram_payment_charge_id": "CHARGE_ID",
  "is_canceled": true
}'

Python

import requests

TOKEN = "123456789:AAEexampleTokenReplaceWithYours"
resp = requests.post(
    f"https://api.telegram.org/bot{TOKEN}/editUserStarSubscription",
    json={
        "user_id": 123456789,
        "telegram_payment_charge_id": "CHARGE_ID",
        "is_canceled": True
    },
    timeout=30,
)
print(resp.json())

JavaScript

const TOKEN = "123456789:AAEexampleTokenReplaceWithYours";
const res = await fetch(`https://api.telegram.org/bot${TOKEN}/editUserStarSubscription`, {
  method: "POST",
  headers: { "Content-Type": "application/json" },
  body: JSON.stringify({
    "user_id": 123456789,
    "telegram_payment_charge_id": "CHARGE_ID",
    "is_canceled": true
  }),
});
console.log(await res.json());

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