Skip to main content
Deno 2 is finally here 🎉️
Learn more
Module

x/grammy/mod.ts>Api#editUserStarSubscription

The Telegram Bot Framework.
grammyjs/grammY
Very Popular
Latest
method Api.prototype.editUserStarSubscription
import { Api } from "https://deno.land/x/grammy@v1.32.0/mod.ts";

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

Parameters

user_id: number

Identifier of the user whose subscription will be edited

telegram_payment_charge_id: string

Telegram payment identifier for the subscription

is_canceled: boolean

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.

optional
signal: AbortSignal

Optional AbortSignal to cancel the request

Official reference: https://core.telegram.org/bots/api#edituserstarsubscription