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_•••'

Get Membership - View a Single Subscription via API

Fetch a single membership record by its ID, including the plan, start and end dates, and—for recurring memberships—the underlying subscription status.

GET/v2/projects/{project_id}/memberships/{membership_id}

Authorization

Bearer API KeyRequired

API key scope: memberships:read (required for restricted keys).

Path Parameters

project_idstringrequired

The unique identifier of the project.

membership_idstringrequired

The unique identifier of the membership.

curl -X GET "https://api.botsubscription.com/v2/projects/YOUR_PROJECT_ID/memberships/bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb" \
  -H "Authorization: Bearer YOUR_API_KEY"

const project_id = 'YOUR_PROJECT_ID';
const membership_id = 'bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb';
const response = await fetch(`https://api.botsubscription.com/v2/projects/${project_id}/memberships/${membership_id}`, {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY'
  }
});
const data = await response.json();

import requests
 
project_id = 'YOUR_PROJECT_ID'
membership_id = 'bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb'
response = requests.get(
    f'https://api.botsubscription.com/v2/projects/{project_id}/memberships/{membership_id}',
    headers={'Authorization': 'Bearer YOUR_API_KEY'}
)
data = response.json()

$project_id = 'YOUR_PROJECT_ID';
$membership_id = 'bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb';
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://api.botsubscription.com/v2/projects/{$project_id}/memberships/{$membership_id}");
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Authorization: Bearer YOUR_API_KEY']);
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/11111111-1111-4111-8111-111111111111/memberships/bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb",
  "code": 200,
  "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,
    "access_token_id": null
  }
}

Membership without a finite end dateapplication/json

{
  "ok": true,
  "request_id": "11111111-1111-1111-1111-111111111111",
  "method": "GET",
  "path": "/v2/projects/11111111-1111-4111-8111-111111111111/memberships/bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb",
  "code": 200,
  "data": {
    "user_id": "123456789012345678",
    "plan_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
    "membership_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb",
    "membership_start_date": "2025-12-29T10:32:27.560Z",
    "payment_request_id": null,
    "membership_end_date": null
  }
}

Not authorized to view this membershipapplication/json

{
  "ok": false,
  "request_id": "11111111-1111-1111-1111-111111111111",
  "method": "GET",
  "path": "/v2/projects/11111111-1111-4111-8111-111111111111/memberships/bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb",
  "code": 401,
  "error": {
    "error_code": "UNAUTHORIZED",
    "message": "You are not authorized to view this membership"
  }
}

Membership not found (admin callers only)application/json

{
  "ok": false,
  "request_id": "11111111-1111-1111-1111-111111111111",
  "method": "GET",
  "path": "/v2/projects/11111111-1111-4111-8111-111111111111/memberships/bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb",
  "code": 404,
  "error": {
    "error_code": "NOT_FOUND",
    "message": "Membership not found"
  }
}

Last updated: November 4, 2026