editUserStarSubscription

Raw MD
Allows the bot to cancel or re-enable extension of a subscription paid in Telegram Stars

Allows the bot to cancel or re-enable extension of a subscription paid in Telegram Stars. Returns True on success.

Parameters

ParameterTypeRequiredDescription
user_idIntegerYesIdentifier of the user whose subscription will be edited
telegram_payment_charge_idStringYesTelegram payment identifier for the subscription
is_canceledBooleanYesPass True to cancel extension of the user subscription; the subscription must be active up to the end of the current subscription period. Pass False to allow the user to re-enable a subscription that was previously canceled by the bot.

Example

PHP — Call editUserStarSubscription on Botlify Cloud
<?php
// ── Botlify Cloud .env — auto-injected, never hardcode secrets ──
$BOT_TOKEN     = getenv('BOT_TOKEN');     // Telegram bot token from @BotFather
$ADMIN_CHAT_ID = getenv('ADMIN_CHAT_ID'); // Your numeric admin Telegram user ID
$BOT_USERNAME  = getenv('BOT_USERNAME');  // Bot username without @

$resp = bot('editUserStarSubscription', [
    'user_id' => $userId,
    'telegram_payment_charge_id' => 'value',
    'is_canceled' => 'value',
]);

if ($resp['ok'] ?? false) {
    $result = $resp['result']; // handle the response
}
Botlify Cloud Runtime
Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference.