API

Get Started

As a member of the TGmembership family, you can use the API to automate your memberships' management. For example, you can connect your Telegram bot directly to your website and give your customers access to your Telegram chats automatically.

Before you can use the TGmembership API, you must have a bot and an API key created. If you don't have one yet, create your Telegram bot and connect it to TGmembership.

Generate API Endpoint

To learn how to generate an API key, please refer to our guide on creating an API key.

Authentication

The TGmembership API uses API keys to authenticate requests. You can view and manage your API key from your bot's settings menu.

All queries to the TGmembership API must be served over HTTPS, using GET, POST, PATCH or DELETE HTTP methods, and need to be presented in this form: https://api.tgmembership.com/{{VERSION}}/bot{{BOT_ID}}/{{API_KEY}}/{{METHOD_NAME}}

Calls made over plain HTTP will fail. API requests without authentication will also fail. All methods in the TGmembership API are case-insensitive.

The response contains a JSON object, which always has a Boolean field "ok", Integer field "code" and may have an optional String field "description" with a human-readable description of the result. If "ok" equals true, the request was successful and the result of the query can be found in the "result" field. In case of an unsuccessful request, "ok" equals false and the error is explained in the "description".

Remove an admin

Remove an admin from the bot.

DELETEhttps://api.tgmembership.com/v1/bot{bot_id}/{api_key}/admins/{admin_id}

Path parameters

bot_id*integer

The unique identifier of the bot.

api_key*string

The API key of the bot.

admin_id*string

The unique identifier of the admin. Can't be the owner of the bot.

Query parameters

Response

204

The admin has been successfully removed.

Request

JavaScriptCurlPython

const response = await fetch('https://api.tgmembership.com/v1/bot{bot_id}/{api_key}/admins/{admin_id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Update an admin

Update the level of access an admin has.

PATCHhttps://api.tgmembership.com/v1/bot{bot_id}/{api_key}/admins/{admin_id}

Path parameters

bot_id*integer

The unique identifier of the bot.

api_key*string

The API key of the bot.

admin_id*string

The unique identifier of the admin. Can't be the owner of the bot.

Body

application/json

admin_level*integer

The level of access the admin has. Must be an integer between 2 and 8.

bot_tokenstring

The API token generated from @BotFather in Telegram.

Response

204304400401403

The admin has been successfully updated.

Request

JavaScriptCurlPython

const response = await fetch('https://api.tgmembership.com/v1/bot{bot_id}/{api_key}/admins/{admin_id}', {
    method: 'PATCH',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "admin_level": 0
    }),
});
const data = await response.json();

Response

400401403

{
  "ok": false,
  "request_id": "text",
  "method": "text",
  "path": "text",
  "code": 400,
  "description": "text"
}

Get all admins

Get a list of all admins who have access to the bot.

GEThttps://api.tgmembership.com/v1/bot{bot_id}/{api_key}/admins

Path parameters

bot_id*integer

The unique identifier of the bot.

api_key*string

The API key of the bot.

Response

200

The list of admins has been successfully retrieved.

Body

application/json

okboolean

request_idstring

methodstring

pathstring

codeinteger

resultarray of object

Request

JavaScriptCurlPython

const response = await fetch('https://api.tgmembership.com/v1/bot{bot_id}/{api_key}/admins', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "ok": true,
  "request_id": "text",
  "method": "text",
  "path": "text",
  "code": 200,
  "result": [
    {
      "admin_id": "text",
      "admin_name": "text",
      "admin_level": 0
    }
  ]
}

Add an admin

Add a new admin to the bot.

POSThttps://api.tgmembership.com/v1/bot{bot_id}/{api_key}/admins

Path parameters

bot_id*integer

The unique identifier of the bot.

api_key*string

The API key of the bot.

Body

application/json

admin_id*string

The unique identifier of the admin.

admin_level*integer

The level of access the admin has. Must be an integer between 2 and 8.

Response

201

The admin has been successfully added.

Body

application/json

okboolean

request_idstring

methodstring

pathstring

codeinteger

resultobject

Request

JavaScriptCurlPython

const response = await fetch('https://api.tgmembership.com/v1/bot{bot_id}/{api_key}/admins', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "admin_id": "text",
      "admin_level": 0
    }),
});
const data = await response.json();

Response

201

{
  "ok": true,
  "request_id": "text",
  "method": "text",
  "path": "text",
  "code": 201,
  "result": {
    "admin_id": "text",
    "admin_name": "text",
    "admin_level": 0
  }
}

Register an affiliate

Register new affiliates into the affiliate program within the bot.

POSThttps://api.tgmembership.com/v1/bot{bot_id}/{api_key}/affiliate

Path parameters

bot_id*integer

The unique identifier of the bot.

api_key*string

The API key of the bot.

Body

application/json

member_id*integer

The unique identifier of a member who has previously interacted with the bot and has not blocked it.

affiliate_idstring

A user-chosen string that identifies the affiliate. It must start with a letter, be at least 3 characters long, no more than 12, and be unique (not used by anyone else).

Response

200400401404409

The affiliate has been registered successfully.

Body

application/json

okboolean

request_idstring

methodstring

pathstring

codeinteger

resultobject

Request

JavaScriptCurlPython

const response = await fetch('https://api.tgmembership.com/v1/bot{bot_id}/{api_key}/affiliate', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "member_id": 0
    }),
});
const data = await response.json();

Response

200400401404409

{
  "ok": true,
  "request_id": "text",
  "method": "text",
  "path": "text",
  "code": 200,
  "result": {
    "affiliate_id": "text",
    "affiliate_link": "text"
  }
}

Get bot details

Get details of the bot.

GEThttps://api.tgmembership.com/v1/bot{bot_id}/{api_key}/bot

Path parameters

bot_id*integer

The unique identifier of the bot.

api_key*string

The API key of the bot.

Query parameters

Response

200

The bot details have been successfully retrieved.

Body

application/json

okboolean

request_idstring

methodstring

pathstring

codeinteger

resultobject

Request

JavaScriptCurlPython

const response = await fetch('https://api.tgmembership.com/v1/bot{bot_id}/{api_key}/bot', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "ok": true,
  "request_id": "text",
  "method": "text",
  "path": "text",
  "code": 200,
  "result": {
    "bot_id": 0,
    "api_key": "text"
  }
}

Register a bot

This endpoint allows you to register a new bot. The owner of the bot that owns the API key used for this call will also be registered as the owner and billpayer for the new bot.

POSThttps://api.tgmembership.com/v1/bot{bot_id}/{api_key}/bot

Path parameters

bot_id*integer

The unique identifier of the bot.

api_key*string

The API key of the bot.

Body

application/json

bot_token*string

The API token generated from @BotFather in Telegram.

Response

201402409

The bot has been successfully registered.

Body

application/json

okboolean

request_idstring

methodstring

pathstring

codeinteger

resultobject

Request

JavaScriptCurlPython

const response = await fetch('https://api.tgmembership.com/v1/bot{bot_id}/{api_key}/bot', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "bot_token": "text"
    }),
});
const data = await response.json();

Response

201402409

{
  "ok": true,
  "request_id": "text",
  "method": "text",
  "path": "text",
  "code": 201,
  "result": {
    "bot_id": 0,
    "bot_username": "text",
    "api_key": "text"
  }
}

Get all chats

Get a list of all chats that the bot is currently in.

GEThttps://api.tgmembership.com/v1/bot{bot_id}/{api_key}/chats

Path parameters

bot_id*integer

The unique identifier of the bot.

api_key*string

The API key of the bot.

Response

200

The list of chats has been successfully retrieved.

Body

application/json

okboolean

request_idstring

methodstring

pathstring

codeinteger

resultarray of object

Request

JavaScriptCurlPython

const response = await fetch('https://api.tgmembership.com/v1/bot{bot_id}/{api_key}/chats', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "ok": true,
  "request_id": "text",
  "method": "text",
  "path": "text",
  "code": 200,
  "result": [
    {
      "chat_id": 0,
      "chat_name": "text",
      "chat_type": "text"
    }
  ]
}

Add a chat

Add a new chat to the bot.

POSThttps://api.tgmembership.com/v1/bot{bot_id}/{api_key}/chats

Path parameters

bot_id*integer

The unique identifier of the bot.

api_key*string

The API key of the bot.

Body

application/json

chat_id*integer

The unique identifier of the chat.

chat_name*string

The name of the chat.

chat_type*enum

The type of the chat. Must be one of 'private', 'group', 'supergroup', or 'channel'.

groupsupergroupchannel

Response

201409

The chat has been successfully added.

Body

application/json

okboolean

request_idstring

methodstring

pathstring

codeinteger

resultobject

Request

JavaScriptCurlPython

const response = await fetch('https://api.tgmembership.com/v1/bot{bot_id}/{api_key}/chats', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "chat_id": 0,
      "chat_name": "text",
      "chat_type": "group"
    }),
});
const data = await response.json();

Response

201409

{
  "ok": true,
  "request_id": "text",
  "method": "text",
  "path": "text",
  "code": 201,
  "result": {
    "chat_id": 0,
    "chat_name": "text",
    "chat_type": "group"
  }
}

Remove a chat

Remove a chat from the bot.

DELETEhttps://api.tgmembership.com/v1/bot{bot_id}/{api_key}/chats/{chat_id}

Path parameters

bot_id*integer

The unique identifier of the bot.

api_key*string

The API key of the bot.

chat_id*integer

The unique identifier of the chat.

Response

204404

The chat has been successfully removed.

Request

JavaScriptCurlPython

const response = await fetch('https://api.tgmembership.com/v1/bot{bot_id}/{api_key}/chats/{chat_id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

404

{
  "ok": false,
  "request_id": "text",
  "method": "text",
  "path": "text",
  "code": 404,
  "description": "text"
}

Get all coupons

Get a list of all coupons created in the bot.

GEThttps://api.tgmembership.com/v1/bot{bot_id}/{api_key}/coupons

Path parameters

bot_id*integer

The unique identifier of the bot.

api_key*string

The API key of the bot.

Response

200404

The list of coupons has been successfully retrieved.

Body

application/json

okboolean

request_idstring

methodstring

pathstring

codeinteger

resultarray of object

Request

JavaScriptCurlPython

const response = await fetch('https://api.tgmembership.com/v1/bot{bot_id}/{api_key}/coupons', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200404

{
  "ok": true,
  "request_id": "text",
  "method": "text",
  "path": "text",
  "code": 200,
  "result": [
    {
      "name": "text",
      "amount": "text",
      "percent": "text",
      "min_amount": "text",
      "max_amount": "text",
      "uses": 0,
      "used": 0,
      "plans": [],
      "newcomers": false,
      "singleuse": false,
      "invitee_only": false,
      "auto_apply": false,
      "enabled": false
    }
  ]
}

Get invite link

Get the invite link for a chat.

GEThttps://api.tgmembership.com/v1/bot{bot_id}/{api_key}/inviteLink/{chat_id}/{member_id}

Path parameters

bot_id*integer

The unique identifier of the bot.

api_key*string

The API key of the bot.

chat_id*integer

The unique identifier of the chat.

member_id*integer

The unique identifier of a member who has previously interacted with the bot and has not blocked it.

Response

201403404410

The invite link has been successfully retrieved.

Body

application/json

okboolean

request_idstring

methodstring

pathstring

codeinteger

resultobject

Request

JavaScriptCurlPython

const response = await fetch('https://api.tgmembership.com/v1/bot{bot_id}/{api_key}/inviteLink/{chat_id}/{member_id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

201403404410

{
  "ok": true,
  "request_id": "text",
  "method": "text",
  "path": "text",
  "code": 201,
  "result": {
    "invite_link": "text"
  }
}

Get all members

Get a list of all members who have an active membership in the bot.

GEThttps://api.tgmembership.com/v1/bot{bot_id}/{api_key}/members

Path parameters

bot_id*integer

The unique identifier of the bot.

api_key*string

The API key of the bot.

Query parameters

Response

200

The list of members has been successfully retrieved.

Body

application/json

okboolean

request_idstring

methodstring

pathstring

codeinteger

resultarray of object

Request

JavaScriptCurlPython

const response = await fetch('https://api.tgmembership.com/v1/bot{bot_id}/{api_key}/members', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "ok": true,
  "request_id": "text",
  "method": "text",
  "path": "text",
  "code": 200,
  "result": [
    {
      "member_id": 0,
      "member_email": "text",
      "plan_id": 0,
      "project_id": 0,
      "membership": {
        "start": 0,
        "end": 0,
        "start_date": "text",
        "end_date": "text"
      }
    }
  ]
}

Get a member

Get details of a member.

GEThttps://api.tgmembership.com/v1/bot{bot_id}/{api_key}/members/{member_id}

Path parameters

bot_id*integer

The unique identifier of the bot.

api_key*string

The API key of the bot.

member_id*integer

The unique identifier of a member who has previously interacted with the bot and has not blocked it.

Response

200

The member details have been successfully retrieved.

Body

application/json

okboolean

request_idstring

methodstring

pathstring

codeinteger

resultobject

Request

JavaScriptCurlPython

const response = await fetch('https://api.tgmembership.com/v1/bot{bot_id}/{api_key}/members/{member_id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "ok": true,
  "request_id": "text",
  "method": "text",
  "path": "text",
  "code": 200,
  "result": {
    "member_id": 0,
    "plan_id": 0,
    "project_id": 0,
    "membership": {
      "start": 0,
      "end": 0,
      "start_date": "text",
      "end_date": "text"
    }
  }
}

Update a member

Update the membership of a member.

PATCHhttps://api.tgmembership.com/v1/bot{bot_id}/{api_key}/members/{member_id}

Path parameters

bot_id*integer

The unique identifier of the bot.

api_key*string

The API key of the bot.

member_id*integer

The unique identifier of a member who has previously interacted with the bot and has not blocked it.

Body

application/json

project_idinteger

The unique identifier of an existing project. Must be a positive number.

membershipobject

Response

200304400403404

The member has been successfully updated.

Body

application/json

okboolean

request_idstring

methodstring

pathstring

codeinteger

resultobject

Request

JavaScriptCurlPython

const response = await fetch('https://api.tgmembership.com/v1/bot{bot_id}/{api_key}/members/{member_id}', {
    method: 'PATCH',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200304400403404

{
  "ok": true,
  "request_id": "text",
  "method": "text",
  "path": "text",
  "code": 200,
  "result": {
    "member_id": 0,
    "plan_id": 0,
    "project_id": 0,
    "membership": {
      "start": 0,
      "end": 0,
      "start_date": "text",
      "end_date": "text"
    }
  }
}

Create an access token

Create a new access token for a member to activate memberships without payment. For more information on access tokens, please check out our help article.

POSThttps://api.tgmembership.com/v1/bot{bot_id}/{api_key}/members/accessToken

Path parameters

bot_id*integer

The unique identifier of the bot.

api_key*string

The API key of the bot.

Body

application/json

plan_id*integer

The unique identifier of an existing plan. Must be a positive number.

member_idstring

The unique identifier of a member who has previously interacted with the bot and has not blocked it.

Response

201400401404

The access token has been successfully created.

Body

application/json

okboolean

request_idstring

methodstring

pathstring

codeinteger

resultobject

Request

JavaScriptCurlPython

const response = await fetch('https://api.tgmembership.com/v1/bot{bot_id}/{api_key}/members/accessToken', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "plan_id": 0
    }),
});
const data = await response.json();

Response

201400401404

{
  "ok": true,
  "request_id": "text",
  "method": "text",
  "path": "text",
  "code": 201,
  "result": {
    "bot_username": "text",
    "access_token": "text",
    "link": "text"
  }
}

Retrieve an order

Retrieve an order by its unique order key.

GEThttps://api.tgmembership.com/v1/bot{bot_id}/{api_key}/orders/{order_key}

Path parameters

bot_id*integer

The unique identifier of the bot.

api_key*string

The API key of the bot.

order_key*string

The unique identifier of the order.

Response

200404

The order has been successfully retrieved.

Body

application/json

okboolean

request_idstring

methodstring

pathstring

codeinteger

resultobject

Request

JavaScriptCurlPython

const response = await fetch('https://api.tgmembership.com/v1/bot{bot_id}/{api_key}/orders/{order_key}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200404

{
  "ok": true,
  "request_id": "text",
  "method": "text",
  "path": "text",
  "code": 200,
  "result": {
    "order_key": "text",
    "order_type": 0,
    "order_date": 0,
    "order_status": "text",
    "member_id": 0,
    "member_name": "text",
    "member_email": "text",
    "payment_gateway": "text",
    "plan_id": 0,
    "plan_name": "text",
    "project_id": 0,
    "amount": "text",
    "currency": "text",
    "formatted": "text",
    "coupon_code": "text"
  }
}

Retrieve all orders

Retrieve a list of all orders created in the bot.

GEThttps://api.tgmembership.com/v1/bot{bot_id}/{api_key}/orders

Path parameters

bot_id*integer

The unique identifier of the bot.

api_key*string

The API key of the bot.

Query parameters

Response

200

The list of orders has been successfully retrieved.

Body

application/json

okboolean

request_idstring

methodstring

pathstring

codeinteger

resultarray of object

Request

JavaScriptCurlPython

const response = await fetch('https://api.tgmembership.com/v1/bot{bot_id}/{api_key}/orders', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "ok": true,
  "request_id": "text",
  "method": "text",
  "path": "text",
  "code": 200,
  "result": [
    {
      "order_key": "text",
      "order_type": 0,
      "order_date": 0,
      "order_status": "text",
      "member_id": 0,
      "member_name": "text",
      "member_email": "text",
      "payment_gateway": "text",
      "plan_id": 0,
      "plan_name": "text",
      "project_id": 0,
      "amount": "text",
      "currency": "text",
      "formatted": "text",
      "coupon": "text"
    }
  ]
}

Create an order

Create a new order for a member to purchase a plan or project.

POSThttps://api.tgmembership.com/v1/bot{bot_id}/{api_key}/orders

Path parameters

bot_id*integer

The unique identifier of the bot.

api_key*string

The API key of the bot.

Body

application/json

plan_id*integer

The unique identifier of an existing plan. Must be a positive number.

payment_gateway*string

The payment gateway to use for the order. Must be installed in the bot. For a list of available payment gateways, use the /bot{bot_id}/{api_key}/paymentGateways endpoint.

member_idinteger

The unique identifier of a member who has previously interacted with the bot and has not blocked it.

emailstring

Required for specific payment methods, such as Paystack. Otherwise, this parameter is optional.

tokenstring

Needed for specific payment methods, such as crypto. For BinancePay, pass the token name, e.g., "USDT." For CryptoNoKYC, include both the token name and the network, formatted as "TOKEN.NETWORK"

return_urlstring

The URL to redirect the member to after the payment is completed. Applicable only for payment methods that support custom return URLs, such as Stripe.

cancel_urlstring

The URL to redirect the member to after the payment is canceled. Applicable only for payment methods that support custom cancel URLs, such as Stripe.

Response

200400

The order has been successfully created.

Body

application/json

okboolean

request_idstring

methodstring

pathstring

codeinteger

resultarray of object

Request

JavaScriptCurlPython

const response = await fetch('https://api.tgmembership.com/v1/bot{bot_id}/{api_key}/orders', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "plan_id": 0,
      "payment_gateway": "text"
    }),
});
const data = await response.json();

Response

200400

{
  "ok": true,
  "request_id": "text",
  "method": "text",
  "path": "text",
  "code": 200,
  "result": [
    {
      "order_key": "text",
      "amount": "text",
      "currency": "text",
      "checkout_url": "text"
    }
  ]
}

Get order count

Retrieve a list of daily, monthly, or yearly revenue and sales data.

GEThttps://api.tgmembership.com/v1/bot{bot_id}/{api_key}/orders/count

Path parameters

bot_id*integer

The unique identifier of the bot.

api_key*string

The API key of the bot.

Query parameters

Response

200

The order count has been successfully retrieved.

Body

application/json

okboolean

request_idstring

methodstring

pathstring

codeinteger

resultarray of object

Request

JavaScriptCurlPython

const response = await fetch('https://api.tgmembership.com/v1/bot{bot_id}/{api_key}/orders/count', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "ok": true,
  "request_id": "text",
  "method": "text",
  "path": "text",
  "code": 200,
  "result": [
    {
      "period": "text",
      "revenue": "text",
      "currency": "text",
      "formatted": "text",
      "sales": 0
    }
  ]
}

Retrieve all payment gateways

Retrieve a list of all payment gateways installed in the bot.

GEThttps://api.tgmembership.com/v1/bot{bot_id}/{api_key}/paymentGateways

Path parameters

bot_id*integer

The unique identifier of the bot.

api_key*string

The API key of the bot.

Response

200

The list of payment gateways has been successfully retrieved.

Body

application/json

okboolean

request_idstring

methodstring

pathstring

codeinteger

resultarray of object

Request

JavaScriptCurlPython

const response = await fetch('https://api.tgmembership.com/v1/bot{bot_id}/{api_key}/paymentGateways', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "ok": true,
  "request_id": "text",
  "method": "text",
  "path": "text",
  "code": 200,
  "result": [
    {
      "name": "text",
      "display_name": "text",
      "supports_recurring": false,
      "requires_email": false,
      "tokens": [
        {
          "token": "text",
          "display_name": "text"
        }
      ]
    }
  ]
}

Get payment gateway report

Retrieve a list of daily, monthly, or yearly revenue and sales data for each payment gateway.

GEThttps://api.tgmembership.com/v1/bot{bot_id}/{api_key}/paymentGateways/report

Path parameters

bot_id*integer

The unique identifier of the bot.

api_key*string

The API key of the bot.

Query parameters

Response

200

The payment gateway report has been successfully retrieved.

Body

application/json

okboolean

request_idstring

methodstring

pathstring

codeinteger

resultarray of object

Request

JavaScriptCurlPython

const response = await fetch('https://api.tgmembership.com/v1/bot{bot_id}/{api_key}/paymentGateways/report', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "ok": true,
  "request_id": "text",
  "method": "text",
  "path": "text",
  "code": 200,
  "result": [
    {
      "name": "text",
      "display_name": "text",
      "revenue": "text",
      "currency": "text",
      "formatted": "text",
      "sales": 0
    }
  ]
}

Retrieve all plans

Retrieve a list of all plans created in the bot.

GEThttps://api.tgmembership.com/v1/bot{bot_id}/{api_key}/plans

Path parameters

bot_id*integer

The unique identifier of the bot.

api_key*string

The API key of the bot.

Query parameters

Response

200404

The list of plans has been successfully retrieved.

Body

application/json

okboolean

request_idstring

methodstring

pathstring

codeinteger

resultarray of object

Request

JavaScriptCurlPython

const response = await fetch('https://api.tgmembership.com/v1/bot{bot_id}/{api_key}/plans', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200404

{
  "ok": true,
  "request_id": "text",
  "method": "text",
  "path": "text",
  "code": 200,
  "result": [
    {
      "plan_id": 0,
      "plan_name": "text",
      "duration": "text",
      "price": "text",
      "currency": "text",
      "options": {
        "recurring": false,
        "newcomers": 0,
        "singleuse": 0,
        "token_only": false,
        "credit_only": false,
        "invitee_only": 0,
        "is_hidden": false
      },
      "max_customers": 0,
      "sort_order": 0,
      "enabled": false
    }
  ]
}

Create a plan

Create a new plan for members to purchase.

POSThttps://api.tgmembership.com/v1/bot{bot_id}/{api_key}/plans

Path parameters

bot_id*integer

The unique identifier of the bot.

api_key*string

The API key of the bot.

Body

application/json

plan_namestring

The name of the subscription plan. The name must be between 3 and 24 characters long, and start with a letter.

plan_durationstring

The duration of the subscription plan. This is typically specified in a format like "1 month" or "1 year".

plan_pricestring

The price of the subscription plan. This should include the amount without currency code.

plan_currencystring

The currency of the plan. Must be a valid ISO 4217 currency code.

plan_trialstring

The duration of the trial period for the subscription plan. This is typically specified in a format like "1 month" or "1 year".

plan_project_idinteger

The unique identifier of an existing project. Must be a positive number.

optionsobject

Response

201

The plan has been successfully created.

Body

application/json

okboolean

request_idstring

methodstring

pathstring

codeinteger

resultobject

Request

JavaScriptCurlPython

const response = await fetch('https://api.tgmembership.com/v1/bot{bot_id}/{api_key}/plans', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

201

{
  "ok": true,
  "request_id": "text",
  "method": "text",
  "path": "text",
  "code": 201,
  "result": {
    "plan_id": 0,
    "plan_name": "text",
    "duration": "text",
    "price": "text",
    "currency": "text",
    "options": {
      "recurring": false,
      "newcomers": 0,
      "singleuse": 0,
      "token_only": false,
      "credit_only": false,
      "invitee_only": 0,
      "is_hidden": false
    },
    "max_customers": 0,
    "sort_order": 0,
    "enabled": false
  }
}

Get plan report

Retrieve a list of revenue and number of sales for each subscription plan on a monthly basis for the last 6 months.

GEThttps://api.tgmembership.com/v1/bot{bot_id}/{api_key}/plans/report

Path parameters

bot_id*integer

The unique identifier of the bot.

api_key*string

The API key of the bot.

Query parameters

Response

200

The plan report has been successfully retrieved.

Body

application/json

okboolean

request_idstring

methodstring

pathstring

codeinteger

resultarray of object

Request

JavaScriptCurlPython

const response = await fetch('https://api.tgmembership.com/v1/bot{bot_id}/{api_key}/plans/report', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

[
  {
    "ok": true,
    "request_id": "text",
    "method": "text",
    "path": "text",
    "code": 200,
    "result": [
      {
        "plan_id": 0,
        "plan_name": "text",
        "revenue": "text",
        "currency": "text",
        "formatted": "text",
        "sales": 0,
        "breakdown": [
          {
            "period": "text",
            "revenue": "text",
            "currency": "text",
            "formatted": "text",
            "sales": 0
          }
        ]
      }
    ]
  }
]

Retrieve all projects

Retrieve a list of all projects created in the bot.

GEThttps://api.tgmembership.com/v1/bot{bot_id}/{api_key}/projects

Path parameters

bot_id*integer

The unique identifier of the bot.

api_key*string

The API key of the bot.

Query parameters

Response

200401404

The list of projects has been successfully retrieved.

Body

application/json

okboolean

request_idstring

methodstring

pathstring

codeinteger

resultarray of object

Request

JavaScriptCurlPython

const response = await fetch('https://api.tgmembership.com/v1/bot{bot_id}/{api_key}/projects', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200401404

{
  "ok": true,
  "request_id": "text",
  "method": "text",
  "path": "text",
  "code": 200,
  "result": [
    {
      "project_id": 0,
      "project_name": "text",
      "options": {
        "sort_order": 0,
        "is_hidden": false
      }
    }
  ]
}

Get revenue report

Retrieve the total revenue generated and the number of sales for a specific period of time.

GEThttps://api.tgmembership.com/v1/bot{bot_id}/{api_key}/revenue

Path parameters

bot_id*integer

The unique identifier of the bot.

api_key*string

The API key of the bot.

Query parameters

Response

200

The revenue report has been successfully retrieved.

Body

application/json

okboolean

request_idstring

methodstring

pathstring

codeinteger

resultobject

Request

JavaScriptCurlPython

const response = await fetch('https://api.tgmembership.com/v1/bot{bot_id}/{api_key}/revenue', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "ok": true,
  "request_id": "text",
  "method": "text",
  "path": "text",
  "code": 200,
  "result": {
    "from": 0,
    "to": 0,
    "revenue": "text",
    "currency": "text",
    "formatted": "text",
    "sales": 0
  }
}

Update bot settings

Update the settings of the bot.

PATCHhttps://api.tgmembership.com/v1/bot{bot_id}/{api_key}/settings

Path parameters

bot_id*integer

The unique identifier of the bot.

api_key*string

The API key of the bot.

Body

application/json

settingsobject

Response

204304

The bot settings have been successfully modified.

Body

application/json

okboolean

request_idstring

methodstring

pathstring

codeinteger

Request

JavaScriptCurlPython

const response = await fetch('https://api.tgmembership.com/v1/bot{bot_id}/{api_key}/settings', {
    method: 'PATCH',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

204304

{
  "ok": true,
  "request_id": "text",
  "method": "text",
  "path": "text",
  "code": 204
}

Get user count

Retrieve the total number of users in the bot.

GEThttps://api.tgmembership.com/v1/bot{bot_id}/{api_key}/users/count

Path parameters

bot_id*integer

The unique identifier of the bot.

api_key*string

The API key of the bot.

Response

200

The user count has been successfully retrieved.

Body

application/json

okboolean

request_idstring

methodstring

pathstring

codeinteger

resultobject

Request

JavaScriptCurlPython

const response = await fetch('https://api.tgmembership.com/v1/bot{bot_id}/{api_key}/users/count', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "ok": true,
  "request_id": "text",
  "method": "text",
  "path": "text",
  "code": 200,
  "result": {
    "users": 0,
    "leads": 0,
    "churned": 0,
    "members": 0
  }
}

Delete webhook

Delete the webhook for the bot.

DELETEhttps://api.tgmembership.com/v1/bot{bot_id}/{api_key}/webhook

Path parameters

bot_id*integer

The unique identifier of the bot.

api_key*string

The API key of the bot.

Query parameters

Response

204400404

The webhook has been successfully deleted.

Body

application/json

okboolean

request_idstring

methodstring

pathstring

codeinteger

Request

JavaScriptCurlPython

const response = await fetch('https://api.tgmembership.com/v1/bot{bot_id}/{api_key}/webhook?url=text', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

204400404

{
  "ok": true,
  "request_id": "text",
  "method": "text",
  "path": "text",
  "code": 204
}

Create webhook

Create a new webhook for the bot.

POSThttps://api.tgmembership.com/v1/bot{bot_id}/{api_key}/webhook

Path parameters

bot_id*integer

The unique identifier of the bot.

api_key*string

The API key of the bot.

Body

application/json

urlstring

The URL of your webhook. It must be a valid URL starting with https:// and responding with HTTP 200 to requests, particularly POST.

Response

201409

The webhook has been successfully created.

Body

application/json

okboolean

request_idstring

methodstring

pathstring

codeinteger

resultobject

Request

JavaScriptCurlPython

const response = await fetch('https://api.tgmembership.com/v1/bot{bot_id}/{api_key}/webhook', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

201409

{
  "ok": true,
  "request_id": "text",
  "method": "text",
  "path": "text",
  "code": 201,
  "result": {
    "url": "text",
    "secret": "text"
  }
}