api.botsubscription.com

GET/v1/endpoint

AuthenticationBearer

Token

Stays in this tab. Required for this endpoint — the value below is what gets sent.

Path parameters0

Query parameters0

BodyJSON

Mock

curl --request GET \
  --url https://api.botsubscription.com/v1/endpoint \
  --header 'Authorization: Bearer sk_live_•••'

List Subscription Bot Access Tokens

Read and filter access-token metadata for your Telegram subscription bot or Discord subscription bot. Plaintext codes and activation tickets are never returned.

GET/v2/projects/{project_id}/access-tokens

Authorization

Bearer TokenRequired

Requires memberships:read for a human admin. Restricted project API keys need access-tokens:read.

Path Parameters

project_idstringrequired

The UUID of the project.

Query Parameters

limitintegerDefault: 25

Page size from 1 to 100.

offsetintegerDefault: 0

Nonnegative number of rows to skip.

statusstringDefault: all

active, claimed, revoked, billing_pending, or all.

plan_idstring

Filter by plan UUID.

created_bystring

Creating admin user ID or key:<api key id>.

claimed_bystring

Claimant user ID.

created_frominteger

Inclusive creation lower bound, Unix milliseconds.

created_tointeger

Inclusive creation upper bound, Unix milliseconds.

claimed_frominteger

Inclusive claim lower bound, Unix milliseconds.

claimed_tointeger

Inclusive claim upper bound, Unix milliseconds.

Behavior and recovery

Filters combine with AND. Unknown query fields, invalid values, and reversed date bounds return 422.

Rows include access_token_id, plan_id, duration fields, created_at, revoked_at, claimed_at, claimed_by, claimed_membership_id, and grant_end_date. Nullable fields describe events that have not happened. Billing fields may also be present. All timestamps here are Unix milliseconds, with null for no expiration.

created_by, code_hint (last six code characters), and note help identify batches. No plaintext code or token hash is returned. A list cannot recover lost codes.

Only activated tokens appear in this list. See Prepare Tokens for code capture, or Revoke Token to disable an unused code.

curl -X GET "https://api.botsubscription.com/v2/projects/YOUR_PROJECT_ID/access-tokens?limit=25&status=active" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://api.botsubscription.com/v2/projects/YOUR_PROJECT_ID/access-tokens?limit=25&status=active", {
  method: 'GET',
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});
const result = await response.json();

import requests
 
response = requests.get(
    "https://api.botsubscription.com/v2/projects/YOUR_PROJECT_ID/access-tokens?limit=25&status=active",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    }
)
result = response.json()

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://api.botsubscription.com/v2/projects/YOUR_PROJECT_ID/access-tokens?limit=25&status=active');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'Authorization: Bearer YOUR_TOKEN'
]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);

Token metadataapplication/json

{
  "ok": true,
  "request_id": "44444444-4444-4444-8444-444444444444",
  "method": "GET",
  "path": "/v2/projects/YOUR_PROJECT_ID/access-tokens",
  "code": 200,
  "message": "Success",
  "data": [
    {
      "access_token_id": "11111111-1111-4111-8111-111111111111",
      "plan_id": "22222222-2222-4222-8222-222222222222",
      "duration_seconds": null,
      "duration_months": 1,
      "created_at": 1792430400000,
      "revoked_at": null,
      "claimed_at": null,
      "claimed_by": null,
      "claimed_membership_id": null,
      "grant_end_date": null,
      "created_by": "123456789012345678",
      "code_hint": "ABCDEF",
      "note": "Conference guests"
    }
  ]
}

Last updated: October 19, 2026