Skip to main content

Service, account and plans

All paths below use https://api.lordbase.com. Read conventions for headers, authentication, pagination and error handling. Values in responses are illustrative; examples show selected fields, not fixed quotas or service guarantees.

Developer tokens authorize only explicitly supported operations. Required scopes appear below; account, billing and token-management operations require a dashboard session. See token permissions.

Check API reachability — GET​

GET /e/v1/health/

Authentication: None. This operation is public; omit credentials.

Request and permissions: Public; no authentication or body. This checks API reachability, not your database connection.

Response: 200

{
  "status": "healthy",
  "service": "s0012",
  "version": "1.0.0"
}

Failures: Common API errors, plus the validation, role, state, engine and plan restrictions stated above.

Read your developer profile — GET​

GET /e/v1/auth/me/

Authentication: Dashboard session required; developer tokens are denied, including api tokens. An active Lordbase subscription is required.

Request and permissions: Authenticated account with an active Lordbase subscription; no body.

Response: 200

{
  "id": "ACCOUNT_ID",
  "email": "[email protected]",
  "first_name": "Alex",
  "last_name": "Developer"
}

Failures: Common API errors, plus the validation, role, state, engine and plan restrictions stated above.

Read your plan and usage — GET​

GET /e/v1/developer/plan/

Authentication: Authenticated developer with an active Lordbase subscription. Use the dashboard session, or Authorization: Bearer YOUR_DEVELOPER_TOKEN with read_workspaces (or api). Resource roles and quotas still apply.

Request and permissions: No body. Reads the authenticated account’s active plan and aggregate usage.

Response: 200

{
  "product": "lordbase",
  "has_active_plan": true,
  "plan_info": {},
  "source_user_plan_id": "USER_PLAN_ID",
  "limits": {
    "max_databases": 5
  },
  "usage": {
    "databases": 1,
    "storage_mb": 0,
    "database_users": 0
  }
}

Failures: Common API errors, plus the validation, role, state, engine and plan restrictions stated above.

Inspect plan limits — GET​

GET /e/v1/developer/plan/limits/

Authentication: Authenticated developer with an active Lordbase subscription. Use the dashboard session, or Authorization: Bearer YOUR_DEVELOPER_TOKEN with read_workspaces (or api). Resource roles and quotas still apply.

Request and permissions: Optional query product (string, default lordbase). No body. An unavailable plan check may appear as has_active_plan=false; confirm in Billing before purchasing again.

Response: 200

{
  "user_id": "ACCOUNT_ID",
  "product": "lordbase",
  "has_active_plan": true,
  "exceeding_limits": [],
  "within_limits": [],
  "recommendations": []
}

Failures: Common API errors, plus the validation, role, state, engine and plan restrictions stated above.

Refresh cached plan information — POST​

POST /e/v1/developer/plan/clear-cache/

Authentication: Dashboard session required; developer tokens are denied, including api tokens. An active Lordbase subscription is required.

Request and permissions: No body. Clears your cached plan data; this does not grant or activate a subscription.

Response: 200

{
  "message": "Feature cache cleared successfully",
  "user_id": "ACCOUNT_ID"
}

Failures: Common API errors, plus the validation, role, state, engine and plan restrictions stated above.

Read available Lordbase plans — GET​

GET /e/v1/public/billing-plans/

Authentication: None. This operation is public; omit credentials.

Request and permissions: No body. Public catalogue; amounts and identifiers are deployment-specific.

Response: 200

{
  "paypal_client_id": "PUBLIC_CLIENT_ID",
  "plans": [],
  "currency": "USD"
}

Failures: Common API errors, plus the validation, role, state, engine and plan restrictions stated above.

Activate an approved paid subscription — POST​

POST /e/v1/developer/billing/subscribe/

Authentication: Dashboard session required; developer tokens are denied, including api tokens.

Request and permissions: Dashboard session only. Required plan_id and subscription_id from the supported checkout. The plan must belong to Lordbase; payment is verified before activation.

Example JSON body:

{
  "plan_id": 1,
  "subscription_id": "APPROVED_SUBSCRIPTION_ID"
}

Response: 201

{}

Failures: Common API errors, plus the validation, role, state, engine and plan restrictions stated above.

Activate a free Lordbase plan — POST​

POST /e/v1/developer/billing/subscribe-free/

Authentication: Dashboard session required; developer tokens are denied, including api tokens.

Request and permissions: Dashboard session only. Required plan_slug from the Lordbase free-plan catalogue. Paid or other-product plans are rejected.

Example JSON body:

{
  "plan_slug": "free-lordbase"
}

Response: 201

{}

Failures: Common API errors, plus the validation, role, state, engine and plan restrictions stated above.