Get the Pay to Chat setting
The creator’s Pay to Chat / Sub to Chat setting, or with `account` the one that applies to that Telegram account.
Questions? [email protected]
The creator’s Pay to Chat / Sub to Chat setting, or with `account` the one that applies to that Telegram account.
Questions? [email protected]
/api/external/v1/chat-gatealso served at /api/external/chat-gateNewThe creator’s Pay to Chat / Sub to Chat setting, or with account the one that applies to that Telegram account.
An account’s own setting wins over the creator’s. The response also carries the subscription Sub to Chat sells, the chatbots on the creator’s accounts and the accounts with their own setting. See Pay to Chat from your own chatbot.
Send the creator's API key as a bearer token: Authorization: Bearer dpfn_…. See Authentication & API keys.
For a creator you manage or onboarded
GET /api/external/v1/creators/{creatorId}/chat-gate — an agency's own key for a creator or AI persona it manages (needs canManageDrops), or your app owner's own key for an account your app onboarded. The X-Dropfans-Account header still works but is deprecated. See Acting for a creator.
| Name | Type | Required | Description |
|---|---|---|---|
account | string | Optional | Telegram user id of one of the creator’s accounts. |
| Name | Type | Description | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
account | string | null | The account asked about, or null for the creator’s setting. | ||||||||||||||||||
mode | string | Who may chat: everyone, fans who paid (tip or drop) or subscribed, or subscribers only. One of: EVERYONE, PAY, SUB | ||||||||||||||||||
payScope | string | Pay to Chat: ONCE = paid once, open for good; PER_CONVERSATION = a conversation can be ended and the fan pays again.One of: ONCE, PER_CONVERSATION | ||||||||||||||||||
source | string | account: that Telegram account has its own setting; creator: the creator’s applies.One of: account, creator | ||||||||||||||||||
tier | object | null | The subscription Sub to Chat sells; null when none is on sale (Sub to Chat then asks nobody).Show child attributes
| ||||||||||||||||||
chatbots | object[] | Chatbots reported on the creator’s accounts: ours (app Dropfans) and partner apps’.Show child attributes
| ||||||||||||||||||
accountSettings | object[] | Accounts with their own setting.Show child attributes
|
{
"account": null,
"mode": "PAY",
"payScope": "ONCE",
"source": "creator",
"tier": {
"priceUsd": 14.99,
"interval": "month"
},
"chatbots": [
{
"account": "5550001111",
"app": "Your CRM",
"botUsername": "your_bot",
"enabled": true,
"canReply": true,
"updatedAt": "2026-11-12T10:00:00.000Z"
}
],
"accountSettings": [
{
"account": "5550002222",
"mode": "SUB",
"payScope": "ONCE"
}
]
}| Status | Body | When |
|---|---|---|
| 400 | {"error":"account must be a Telegram user id (digits, as a string)","code":"invalid_telegram_id"} | `account` is missing or not a Telegram user id. |
| 401 | {"error":"Unauthorized","code":"unauthorized"} | Missing or invalid API key. |
| 403 | {"error":"This endpoint needs a key bound to an app with the chat_gate API category enabled — personal keys cannot use it.","code":"app_key_required","category":"chat_gate"} | A personal key: the chat gate answers back through app webhooks. |
| 409 | {"error":"The chat gate is for creator accounts.","code":"not_a_creator"} | The account is a fan account, suspended or banned. |
| 503 | {"error":"The chat gate is not available right now. Let the message through.","code":"unavailable"} | Something failed on our side. Fail open: let the message stand. |
| 400 | {"error":"X-Dropfans-Account must be an account id (from GET /api/external/agency/creators), not a username.","code":"invalid_account_header"} | `X-Dropfans-Account` is not an account id. |
| 400 | {"error":"X-Dropfans-Account names a different account than the path — send one or the other.","code":"account_mismatch"} | Called under /v1/creators/{creatorId}/ with an `X-Dropfans-Account` naming another account. |
| 403 | {"error":"This key cannot act for that account.","code":"account_not_managed"} | The creator in the path (or `X-Dropfans-Account`) is one this key cannot act for: no ACCEPTED management by your agency and not an account your app onboarded (or it no longer holds a key bound to your app), a key minted for one creator, or someone is suspended, banned or deleted. An unknown id gets the same answer. |
| 403 | {"error":"The agency does not have permission for this on that account.","code":"permission_denied","permission":"canManageDrops"} | For a managed creator: the agency lacks `canManageDrops` on that account. |
| 403 | {"error":"This app does not have the chat_gate API category enabled. Contact support to enable it.","code":"api_category_disabled","category":"chat_gate"} | Your app has the Pay to Chat [API category](/developers/concepts/api-categories) switched off (the default for new apps). |
Every response carries the X-RateLimit-Tier header and, on limited tiers, the per-minute and per-day trios — read X-RateLimit-Remaining and X-RateLimit-Reset instead of hardcoding limits. Details in Rate limits.
curl "https://www.dropfans.io/api/external/v1/chat-gate?account=5550001111" \
-H "Authorization: Bearer $DROPFANS_API_KEY"const res = await fetch(`https://www.dropfans.io/api/external/v1/chat-gate?account=5550001111`, {
headers: {
Authorization: `Bearer ${process.env.DROPFANS_API_KEY}`,
},
});
console.log(await res.json());import os
import requests
res = requests.get(
"https://www.dropfans.io/api/external/v1/chat-gate",
headers={"Authorization": f"Bearer {os.environ['DROPFANS_API_KEY']}"},
params={"account": "5550001111"},
)
print(res.json())