createChatSubscriptionInviteLink
Creates a subscription invite link.
Returns: On success, returns ChatInviteLink.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
chat_id | Integer or String | Yes | Channel ID |
name | String | Optional | Link name |
subscription_period | Integer | Yes | Subscription period in seconds |
subscription_price | Integer | Yes | Subscription price in Telegram Stars |
Example request
curl
curl -s -X POST "https://api.telegram.org/bot$TOKEN/createChatSubscriptionInviteLink" \
-H "Content-Type: application/json" \
-d '{
"chat_id": 123456789,
"subscription_period": 2592000,
"subscription_price": 100
}'
Python
import requests
TOKEN = "123456789:AAEexampleTokenReplaceWithYours"
resp = requests.post(
f"https://api.telegram.org/bot{TOKEN}/createChatSubscriptionInviteLink",
json={
"chat_id": 123456789,
"subscription_period": 2592000,
"subscription_price": 100
},
timeout=30,
)
print(resp.json())
JavaScript
const TOKEN = "123456789:AAEexampleTokenReplaceWithYours";
const res = await fetch(`https://api.telegram.org/bot${TOKEN}/createChatSubscriptionInviteLink`, {
method: "POST",
headers: { "Content-Type": "application/json" },
body: JSON.stringify({
"chat_id": 123456789,
"subscription_period": 2592000,
"subscription_price": 100
}),
});
console.log(await res.json());
Step-by-step guide: How to Create a Telegram Bot: Step by Step with BotFather and Python
Related methods
getChatGets chat information.getChatMemberGets chat member information.getChatMemberCountReturns the number of chat members.getChatAdministratorsReturns a list of chat administrators.setChatTitleSets chat title.setChatDescriptionSets chat description.setChatPhotoSets chat photo.deleteChatPhotoDeletes chat photo.setChatPermissionsSets chat permissions.leaveChatLeaves a chat.exportChatInviteLinkExports the main chat invite link.createChatInviteLinkCreates an invite link.