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 Settings - View All Bot Configuration Options via API

Get the complete configuration for your subscription bot. Settings control behavior like default language, timezone, currency, email collection requirements, support features, and policy URLs. Use this to audit your current configuration or sync settings with external systems.

GET/v2/projects/{project_id}/settings

Authorization

Bearer TokenRequired

Path Parameters

project_idstringrequired

The unique identifier of the project.

curl -X GET "https://api.botsubscription.com/v2/projects/YOUR_PROJECT_ID/settings" \
  -H "Authorization: Bearer YOUR_TOKEN"

const project_id = 'YOUR_PROJECT_ID';
const response = await fetch(`https://api.botsubscription.com/v2/projects/${project_id}/settings`, {
  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}/settings',
    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}/settings");
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/settings",
  "code": 200,
  "message": "Settings retrieved successfully",
  "data": {
    "default_language": "en",
    "timezone_preference": "UTC",
    "date_format_preference": "d MMM 'yy, HH:mm",
    "time_format_preference": "24h",
    "collect_email_on_subscribe": true,
    "default_currency": "USD",
    "support_enabled": true,
    "ai_enabled": true,
    "policies": {
      "terms": {
        "type": "url",
        "value": "https://example.com/terms"
      },
      "privacy": {
        "type": "url",
        "value": "https://example.com/privacy"
      },
      "minimum_age": 18
    }
  }
}

Last updated: May 28, 2026