editUserStarSubscription

Returns boolean ↗

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

Required: user_id, telegram_payment_charge_id, is_canceled

Try it

Token saved Change

Bot Token

Save

user_id

telegram_payment_charge_id

is_canceled — true false

Run Running... Reset

Response

TypeScript example · @effect-ak/tg-bot-client

import { makeTgBotClient } from "@effect-ak/tg-bot-client"

const client = makeTgBotClient({ bot_token: "YOUR_BOT_TOKEN" })

const result = await client.execute("edit_user_star_subscription", {
  user_id: 0,
  telegram_payment_charge_id: "...",
  is_canceled: true
})

Parameters

user_id number Required
Identifier of the user whose subscription will be edited.

telegram_payment_charge_id string Required
Telegram payment identifier for the subscription.

is_canceled boolean 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.

Related methods

editChatInviteLink · editChatSubscriptionInviteLink · editForumTopic · editGeneralForumTopic · editMessageCaption · editMessageChecklist · editMessageLiveLocation · editMessageMedia · editMessageReplyMarkup · editMessageText · editStory