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 Memberships - View Active Subscriptions in Your Bot

Get all active and past subscriptions across your project. Each membership record shows which user holds it, the plan they purchased, subscription dates, and renewal status. You can filter by user ID to view a specific member's subscription history.

membership_end_date may be null for memberships with no scheduled end date. The subscription_id and subscription_status fields are populated only for recurring memberships and may otherwise be null or omitted.

GET/v2/projects/{project_id}/memberships

Authorization

Bearer TokenRequired

Path Parameters

project_idstringrequired

The unique identifier of the project.

Query Parameters

user_idstring

Filter memberships to a single user. When using a user-scoped token, either provide this or set all=true.

allboolean

Request every membership in the project. Project API keys return all memberships by default; user-scoped tokens must set all=true to list beyond their own.

limitintegerDefault: 10

Number of items per page (1–100).

offsetintegerDefault: 0

Number of items to skip.

curl -X GET "https://api.botsubscription.com/v2/projects/YOUR_PROJECT_ID/memberships?limit=20" \
  -H "Authorization: Bearer YOUR_TOKEN"

const project_id = 'YOUR_PROJECT_ID';
const response = await fetch(`https://api.botsubscription.com/v2/projects/${project_id}/memberships?limit=20`, {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_TOKEN'
  }
});
const data = await response.json();

import requests
 
project_id = 'YOUR_PROJECT_ID'
response = requests.get(
    f'https://api.botsubscription.com/v2/projects/{project_id}/memberships',
    params={'limit': 20},
    headers={'Authorization': 'Bearer YOUR_TOKEN'}
)
data = response.json()

$project_id = 'YOUR_PROJECT_ID';
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://api.botsubscription.com/v2/projects/{$project_id}/memberships?limit=20");
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Authorization: Bearer YOUR_TOKEN']);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);

Successapplication/json

{
  "ok": true,
  "request_id": "11111111-1111-1111-1111-111111111111",
  "method": "GET",
  "path": "/v2/projects/YOUR_PROJECT_ID/memberships",
  "code": 200,
  "total": 1,
  "message": "All memberships retrieved successfully",
  "data": [
    {
      "user_id": "123456789012345678",
      "plan_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
      "membership_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb",
      "payment_request_id": "cccccccc-cccc-cccc-cccc-cccccccccccc",
      "membership_start_date": "2025-12-29T10:32:27.560Z",
      "membership_end_date": "2026-01-12T10:32:27.560Z",
      "user_name": {
        "first_name": "John",
        "username": "johndoe"
      },
      "plan_name": "Silver",
      "plan_duration": "1 day",
      "subscription_id": null,
      "subscription_status": null
    }
  ]
}

Last updated: July 8, 2026