Interface StarSubscription

Contains information about subscription to a channel chat, a bot, or a business account that was paid in Telegram Stars.

interface StarSubscription {
    @type: "starSubscription";
    chat_id: number;
    expiration_date: number;
    id: string;
    is_canceled?: boolean;
    is_expiring?: boolean;
    pricing: StarSubscriptionPricing;
    type: StarSubscriptionType;
}

Properties

@type chat_id expiration_date id is_canceled? is_expiring? pricing type

Properties

@type

@type: "starSubscription"

chat_id

chat_id: number

Identifier of the chat that is subscribed.

expiration_date

expiration_date: number

Point in time (Unix timestamp) when the subscription will expire or expired.

id

id: string

Unique identifier of the subscription.

Optional is_canceled

is_canceled?: boolean

True, if the subscription was canceled.

Optional is_expiring

is_expiring?: boolean

True, if the subscription expires soon and there are no enough Telegram Stars on the user's balance to extend it.

pricing

pricing: StarSubscriptionPricing

The subscription plan.

type

type: StarSubscriptionType

Type of the subscription.

Settings

Member Visibility

Theme

On This Page

@typechat_idexpiration_dateidis_canceledis_expiringpricingtype