Link Search Menu Expand Document

Constructor: premiumSubscriptionOption

Back to constructors index

Describes a Telegram Premium subscription option

Attributes:

NameTypeRequiredDescription
currentBoolOptionalWhether this subscription option is currently in use.
can_purchase_upgradeBoolOptionalWhether this subscription option can be used to upgrade the existing Telegram Premium subscription. When upgrading Telegram Premium subscriptions bought through stores, make sure that the store transaction ID is equal to transaction, to avoid upgrading someone else’s account, if the client is currently logged into multiple accounts.
transactionstringOptionalIdentifier of the last in-store transaction for the currently used subscription on the current account.
monthsintYesDuration of subscription in months
currencystringYesThree-letter ISO 4217 currency code
amountlongYesTotal price in the smallest units of the currency (integer, not float/double). For example, for a price of US$ 1.45 pass amount = 145. See the exp parameter in currencies.json, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies).
bot_urlstringYesDeep link used to initiate payment
store_productstringOptionalStore product ID, only for official apps

Type: PremiumSubscriptionOption

Example:

$premiumSubscriptionOption = ['_' => 'premiumSubscriptionOption', 'current' => Bool, 'can_purchase_upgrade' => Bool, 'transaction' => 'string', 'months' => int, 'currency' => 'string', 'amount' => long, 'bot_url' => 'string', 'store_product' => 'string'];