The Organization API enables organization admins to programmatically manage members and their subscriptions. This allows you to create, update, and manage organization members at scale.
All Organization API requests require authentication using a Bearer token. Include your Organization API key in the Authorization header of every request.
Authorization: Bearer YOUR_ORGANIZATION_API_KEYYou can find your Organization API key within the Organization Tab in the dashboard.
const apiKey = 'your_organization_api_key';
const response = await fetch('https://insightsentry.com/api/organization/members/create', {
method: 'POST',
headers: {
'Authorization': `Bearer ${apiKey}`,
'Content-Type': 'application/json'
},
body: JSON.stringify({
uid: 'john_doe', // You can set any uid you want within 100 characters
plan: 'pro',
full_name: 'John Doe'
})
});
const data = await response.json();
console.log(data);Custom plans allow organizations to create tailored subscription plans for their members with specific limits and features beyond the standard Pro, Ultra, and Mega plans. These plans are ideal for organizations with specialized requirements.
Custom plans must be configured by contacting our team. We will work with you to create plans that match your specific requirements and set appropriate pricing.
When creating a custom plan, you can specify the following properties. Any omitted fields will default to the selected feature tier's settings:
| Property | Required | Description |
|---|---|---|
| id | No | Custom identifier for the plan. If not provided, one will be generated. Use this ID when creating or updating members via the API. |
| feature | Yes | Base feature tier: "pro", "ultra", or "mega". Determines default access levels. |
| rate_limit | No | Custom rate limit (requests per minute). Only specify if you need a higher limit than the base plan. |
| websocket_connections | No | Number of concurrent WebSocket connections. Typically not needed unless supporting multiple devices per user. |
| websocket_symbols | No | Number of symbols a user can subscribe to (e.g., 1 series = 1 symbol, 10 quotes = 1 symbol). |
| quota | No | Monthly REST API request limit. Can be set to 0 for unlimited requests. |
Custom plan pricing is determined based on the configured limits and features. We will inform you of the pricing when your custom plan is created.
Retrieve all available plans for your organization, including both regular plans (Pro, Ultra, Mega) and any custom plans that have been configured for you.
GET /api/organization/plans
curl -X GET "https://insightsentry.com/api/organization/plans" \
-H "Authorization: Bearer YOUR_API_KEY"{
"success": true,
"regular_plans": [
{ "name": "pro", "price": 15 },
{ "name": "ultra", "price": 25 },
{ "name": "mega", "price": 50 }
],
"custom_plans": [
{
"name": "ultra_plus",
"price": 40,
"feature": "ultra",
"rate_limit": 80,
"websocket_connections": 1,
"websocket_symbols": 5,
"quota": 0
}
]
}Once you have custom plans configured, you can use them when creating or updating members by passing the custom plan's ID in the plan field:
{
"uid": "john_doe",
"plan": "ultra_plus"
}Creates a new organization member with the specified subscription plan.
POST /api/organization/members/create
| Field | Type | Required | Description |
|---|---|---|---|
| uid | string | Yes | Unique identifier from your application |
| plan | string | Yes | Subscription plan ID: "pro", "ultra", "mega", or a custom plan ID |
| full_name | string | No | Full name of the member |
{
"uid": "john_doe",
"plan": "pro",
"full_name": "John Doe"
}{
"success": true,
"member": {
"uid": "john_doe",
"email": "org_john_doe@company.com",
"full_name": "John Doe",
"role": "member",
"plan": "pro",
"status": "active",
"created_at": "2025-10-02T00:00:00.000Z",
"plan_end_at": "2025-11-01T00:00:00.000Z",
"api_key": "generated_api_key_here",
"websocket_symbols": 2,
"websocket_connections": 1,
"newsfeed": true,
"rate_limit": 60,
"quota": 50000, // 0 means unlimited
"quota_exceeded": false
}
}Retrieves a paginated list of all organization members.
GET /api/organization/members
| Parameter | Type | Default | Description |
|---|---|---|---|
| page | number | 1 | Page number for pagination |
| limit | number | 50 | Number of members per page (max: 50) |
curl -X GET "https://insightsentry.com/api/organization/members?page=1&limit=10" \
-H "Authorization: Bearer YOUR_API_KEY"{
"success": true,
"members": [
{
"uid": "john_doe",
"email": "org_john_doe@company.com",
"full_name": "John Doe",
"role": "member",
"plan": "pro",
"status": "active",
"created_at": "2025-10-02T00:00:00.000Z",
"plan_end_at": "2025-11-01T00:00:00.000Z"
},
{
"uid": "jane_smith",
"email": "org_jane_smith@company.com",
"full_name": "Jane Smith",
"role": "member",
"plan": "ultra",
"status": "active",
"created_at": "2025-10-01T00:00:00.000Z",
"plan_end_at": "2025-11-05T00:00:00.000Z"
}
],
"pagination": {
"page": 1,
"limit": 10,
"total": 25,
"total_pages": 3
}
}Retrieves detailed information about a specific organization member, including API key, quota, and usage statistics.
POST /api/organization/members/get
| Field | Type | Required | Description |
|---|---|---|---|
| uid | string | Yes | Unique identifier |
{
"uid": "john_doe"
}{
"success": true,
"member": {
"uid": "john_doe",
"email": "org_john_doe@company.com",
"full_name": "John Doe",
"role": "member",
"plan": "pro",
"status": "active",
"created_at": "2025-10-02T00:00:00.000Z",
"plan_end_at": "2025-11-01T00:00:00.000Z",
"api_key": "member_api_key_here",
"websocket_symbols": 2,
"websocket_connections": 1,
"newsfeed": true,
"rate_limit": 60,
"quota": 50000,
"quota_exceeded": false,
"quota_reset_time": "2025-10-03T00:00:00.000Z"
}
}Updates a member's full name and/or subscription plan. Plan updates trigger either renewal (same plan) or proration (different plan).
POST /api/organization/members/update
| Field | Type | Required | Description |
|---|---|---|---|
| uid | string | Yes | Unique identifier |
| full_name | string | No | New full name for the member |
| plan | string | No | New plan ID: "pro", "ultra", "mega", or custom plan ID (triggers renewal or proration) |
{
"uid": "john_doe",
"plan": "ultra"
}{
"success": true,
"member": {
"uid": "john_doe",
"email": "org_john_doe@company.com",
"full_name": "John Doe",
"role": "member",
"plan": "ultra",
"status": "active",
"created_at": "2025-10-02T00:00:00.000Z",
"plan_end_at": "2025-11-01T00:00:00.000Z"
},
"proration": {
"old_plan": "pro",
"new_plan": "ultra",
"credit_adjustment": -6.67,
"days_remaining": 20
}
}{
"success": true,
"member": {
"uid": "john_doe",
"email": "org_john_doe@company.com",
"full_name": "John Doe",
"role": "member",
"plan": "pro",
"status": "active",
"created_at": "2025-10-02T00:00:00.000Z",
"plan_end_at": "2025-12-01T00:00:00.000Z"
},
"renewal": {
"plan": "pro",
"amount_charged": 15.00,
"extended_days": 30,
"new_expiration": "2025-12-01T00:00:00.000Z"
}
}Cancels a member's subscription with 90% refund of remaining value (10% cancellation fee applies).
POST /api/organization/members/cancel
| Field | Type | Required | Description |
|---|---|---|---|
| string | No* | Member's email address | |
| uid | string | No* | Member's unique identifier |
*Either email or uid is required (at least one must be provided)
{
"uid": "john_doe"
}OR
{
"email": "org_john_doe@company.com"
}{
"success": true,
"message": "Subscription canceled successfully",
"refund": {
"amount": 13.50,
"fee": 1.50,
"remaining_days": 20,
"original_plan": "pro"
}
}Invalid request or already canceled
{
"success": false,
"error": "Subscription already canceled"
}Member not found
{
"success": false,
"error": "Member not found"
}Direct PayPal subscriber
{
"success": false,
"error": "Cannot cancel direct PayPal subscription via API"
}Rate limit exceeded
{
"success": false,
"error": "Too many requests. Please try again later."
}Deletes an organization member. Members can only be deleted if their subscription has expired.
POST /api/organization/members/delete
| Field | Type | Required | Description |
|---|---|---|---|
| uid | string | Yes | Unique identifier |
{
"uid": "john_doe"
}{
"success": true,
"message": "Member deleted successfully"
}Members with active subscriptions cannot be deleted. Wait until the subscription expires (plan_end_at has passed) before attempting deletion. This prevents accidental deletion of active members.
When updating a member to the same plan they currently have, the system treats this as a renewal.
Pro Plan Renewal:
- Plan Price: $15.00
- Total Charged: $15.00 (no fee, no tax for renewals)
- Extension: 30 days from current plan_end_atWhen changing to a different plan, the system applies proration based on the remaining days in the current subscription.
Days Remaining = (plan_end_at - current_date) / (1 day)
Current Plan Value = (current_plan_price / 30) * days_remaining
New Plan Value = (new_plan_price / 30) * days_remaining
Credit Adjustment = current_plan_value - new_plan_value
If Credit Adjustment < 0 (Upgrade):
Amount Charged = |credit_adjustment| + (|credit_adjustment| * 0.10)
If Credit Adjustment > 0 (Downgrade):
Amount Refunded = credit_adjustment - (credit_adjustment * 0.10)Current Plan: Pro ($15/month)
New Plan: Ultra ($25/month)
Days Remaining: 15 days
Calculations:
- Current Plan Value = ($15 / 30) * 15 = $7.50
- New Plan Value = ($25 / 30) * 15 = $12.50
- Credit Adjustment = $7.50 - $12.50 = -$5.00 (negative = upgrade)
Charges:
- Base Difference: $5.00
- Fee (10%): $0.50
- Total Charged: $5.50
Result: Admin pays $5.50, member upgraded to Ultra planCurrent Plan: Mega ($50/month)
New Plan: Pro ($15/month)
Days Remaining: 20 days
Calculations:
- Current Plan Value = ($50 / 30) * 20 = $33.33
- New Plan Value = ($15 / 30) * 20 = $10.00
- Credit Adjustment = $33.33 - $10.00 = $23.33 (positive = downgrade)
Refund:
- Base Difference: $23.33
- Fee (10%): $2.33
- Total Refunded: $21.00
Result: Admin receives $21.00 credit, member downgraded to Pro planAll Organization API operations use a credit-based billing system. The admin must maintain sufficient credits to perform operations.
| Operation | Credit Impact | Calculation |
|---|---|---|
| Create Member | Deduct | Full plan price |
| Renew Subscription | Deduct | Plan price (no fee) |
| Upgrade Plan | Deduct | Prorated difference + 10% fee |
| Downgrade Plan | Refund | Prorated difference - 10% fee |
| Cancel Subscription | Refund | Remaining value - 10% fee |
All credit transactions are logged in the Credit Usage Section in the dashboard.
When canceling a member's subscription, a 10% cancellation fee is applied, and 90% of the remaining subscription value is refunded to the admin's credit balance.
Days Remaining = (plan_end_at - current_date) / (1 day)
Remaining Value = (plan_price / 30) * days_remaining
Cancellation Fee = remaining_value * 0.10
Refund Amount = remaining_value * 0.90Plan: Pro ($15/month)
Days Remaining: 20 days
Calculations:
- Remaining Value = ($15 / 30) * 20 = $10.00
- Cancellation Fee (10%): $1.00
- Refund Amount (90%): $9.00
Result: Admin receives $9.00 credit backThe Organization API uses standard HTTP status codes and returns structured error responses to help you diagnose and handle issues.
Invalid or missing API key in Authorization header
{
"success": false,
"error": "Invalid or missing API key"
}Invalid request body or parameters
{
"success": false,
"error": "Invalid plan. Allowed plans: pro, ultra, mega"
}Member not found
{
"success": false,
"error": "Member not found"
}Resource conflict (e.g., member already exists or has active subscription)
{
"success": false,
"error": "Cannot delete member with active subscription. Subscription expires at 2025-11-01T00:00:00Z"
}Insufficient credits for operation
{
"success": false,
"error": "Insufficient credits. Required: 25.00, Available: 10.00"
}Rate limit exceeded
{
"success": false,
"error": "Rate limit exceeded. Please try again later."
}Server error during processing
{
"success": false,
"error": "An internal error occurred. Please try again or contact support."
}