Sign in
Telegram Bot API

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

post/editUserStarSubscription

Request

  • Base URL: https://api.telegram.org/bot<bot_token>
  • URL: https://api.telegram.org/bot<bot_token>/editUserStarSubscription
  • Auth: none declared

Request body

user_idinteger required

Identifier of the user whose subscription will be edited

telegram_payment_charge_idstring required

Telegram payment identifier for the subscription

is_canceledboolean required

Pass 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.

Response

Telegram API response

oktrue required
resulttrue required

Changes

No recorded changes to this operation across all 3 revisions of this API.