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

Headers0

BodyJSON

Examples

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 API KeyRequired

API key scope: access-tokens:read (required for restricted keys).

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

Creator user ID or key:<api key id>.

claimed_bystring

Claimant user ID.

created_frominteger

Inclusive creation lower bound, 13-digit Unix milliseconds.

created_tointeger

Inclusive creation upper bound, 13-digit Unix milliseconds.

claimed_frominteger

Inclusive claim lower bound, 13-digit Unix milliseconds.

claimed_tointeger

Inclusive claim upper bound, 13-digit Unix milliseconds.

Behavior and recovery

Filters combine with AND. Date bounds are inclusive exact instants, with no day-start or day-end expansion. Equal bounds are valid. Claimed-date filters exclude unclaimed tokens.

created_from, created_to, claimed_from, and claimed_to accept 13-digit Unix milliseconds. ISO dates, 10-digit Unix seconds, empty values, unknown query fields, and reversed date bounds return 422. For example, use created_from=1700000000000&created_to=1700000000000.

The UTC ISO response format does not change these filter inputs.

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

Note

Response examples use the UTC ISO date format.

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

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_API_KEY"
  }
});
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_API_KEY"
    }
)
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_API_KEY'
]);
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/11111111-1111-4111-8111-111111111111/access-tokens",
  "code": 200,
  "data": [
    {
      "access_token_id": "11111111-1111-4111-8111-111111111111",
      "plan_id": "22222222-2222-4222-8222-222222222222",
      "duration_seconds": null,
      "duration_months": 1,
      "created_at": "2026-10-19T17:20:00.000Z",
      "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",
      "billing_pending": false,
      "billing_amount": null,
      "billing_currency": null
    }
  ]
}

Invalid page limitapplication/json

{
  "ok": false,
  "request_id": "44444444-4444-4444-8444-444444444444",
  "method": "GET",
  "path": "/v2/projects/11111111-1111-4111-8111-111111111111/access-tokens",
  "code": 422,
  "errors": [
    {
      "message": "query: limit is too small; minimum allowed is 1",
      "error_code": "VALIDATION_ERROR"
    }
  ]
}

Unsupported date-filter formatapplication/json

{
  "ok": false,
  "request_id": "44444444-4444-4444-8444-444444444444",
  "method": "GET",
  "path": "/v2/projects/11111111-1111-4111-8111-111111111111/access-tokens",
  "code": 422,
  "errors": [
    {
      "message": "query: created_from: Option 1: value is not a number",
      "error_code": "VALIDATION_ERROR"
    },
    {
      "message": "query: created_from: Option 2: Must contain only digits.",
      "error_code": "VALIDATION_ERROR"
    }
  ]
}

Invalid or expired API keyapplication/json

{
  "ok": false,
  "request_id": "44444444-4444-4444-8444-444444444444",
  "method": "GET",
  "path": "/v2/projects/11111111-1111-4111-8111-111111111111/access-tokens",
  "code": 401,
  "error": {
    "message": "Invalid or expired authentication token.",
    "error_code": "UNAUTHORIZED"
  }
}

Last updated: November 4, 2026