docs/enterprise-solutions/api-reference.mdx
The Enterprise API provides REST endpoints for account management, organization administration, billing, and API key management. These are separate from the Chat Completions API, which handles model inference.
https://api.cline.bot
All endpoints require a Bearer token in the Authorization header:
Authorization: Bearer YOUR_AUTH_TOKEN
Use the same API key or account auth token described in the public API reference.
# Get your user profile
curl https://api.cline.bot/api/v1/users/me \
-H "Authorization: Bearer YOUR_AUTH_TOKEN"
{
"id": "user_abc123",
"email": "[email protected]",
"name": "Your Name",
"active_account_id": "org_xyz789"
}
Manage user accounts, accept terms, check balances, view usage, and configure payment methods.
| Method | Endpoint | Description |
|---|---|---|
GET | /api/v1/users/me | Get current user profile |
PATCH | /api/v1/users/me | Update current user profile |
DELETE | /api/v1/users/me | Delete current user account |
POST | /api/v1/users/me/accept-terms | Accept terms of service |
GET | /api/v1/users/me/remote-config | Get remote configuration for the current user |
PUT | /api/v1/users/active-account | Switch active account (personal or organization) |
GET | /api/v1/users/{id}/balance | Get credit balance |
GET | /api/v1/users/{id}/usages | Get usage history |
| Method | Endpoint | Description |
|---|---|---|
GET | /api/v1/users/{id}/payments | List payment history |
GET | /api/v1/users/{id}/payments/{paymentId} | Get payment details |
GET | /api/v1/users/{id}/payments/{paymentId}/status | Check payment status |
GET | /api/v1/users/{id}/payments/provider/{paymentId} | Get provider-side payment details |
POST | /api/v1/users/credits/checkout | Start a credit purchase checkout |
POST | /api/v1/users/{id}/credits/purchase | Purchase credits directly |
| Method | Endpoint | Description |
|---|---|---|
GET | /api/v1/users/{id}/auto-top-up | Get auto top-up settings |
PUT | /api/v1/users/{id}/auto-top-up | Configure auto top-up |
GET | /api/v1/users/{id}/payment-method/default | Get default payment method |
POST | /api/v1/users/{id}/payment-method/setup-session | Start payment method setup |
GET | /api/v1/users/{id}/promotions | List active promotions |
Create and manage organizations. Organization admins can configure remote settings, manage members, and control billing.
| Method | Endpoint | Description |
|---|---|---|
POST | /api/v1/organizations | Create a new organization |
GET | /api/v1/organizations/{id} | Get organization details |
PUT | /api/v1/organizations/{id} | Update organization settings |
DELETE | /api/v1/organizations/{id} | Delete an organization |
GET | /api/v1/organizations/{id}/api-keys | List organization API keys |
GET | /api/v1/organizations/{id}/remote-config | Get remote config for the org |
GET | /api/v1/organizations/{orgId}/metrics | Get organization usage metrics |
Manage who has access to the organization and what role they hold.
| Method | Endpoint | Description |
|---|---|---|
GET | /api/v1/organizations/{orgId}/members | List all members |
DELETE | /api/v1/organizations/{orgId}/members | Remove members |
GET | /api/v1/organizations/{orgId}/members/available-roles | List assignable roles |
PUT | /api/v1/organizations/{orgId}/members/{memberId}/role | Change a member's role |
GET | /api/v1/organizations/{orgId}/members/{memberId}/usages | Get a member's usage |
Invite new members to join your organization.
| Method | Endpoint | Description |
|---|---|---|
GET | /api/v1/organizations/{orgId}/invites | List pending invites |
POST | /api/v1/organizations/{orgId}/invites | Send new invites |
GET | /api/v1/organizations/{orgId}/invites/count | Get invite count |
DELETE | /api/v1/organizations/{orgId}/invites/{inviteId} | Revoke an invite |
POST | /api/v1/invites/accept | Accept an invite (called by the invitee) |
Manage credits and payments at the organization level. These mirror the user-level payment endpoints but operate on the organization's account.
| Method | Endpoint | Description |
|---|---|---|
GET | /api/v1/organizations/{orgId}/balance | Get org credit balance |
GET | /api/v1/organizations/{orgId}/payments | List payment history |
GET | /api/v1/organizations/{orgId}/payments/{paymentId} | Get payment details |
GET | /api/v1/organizations/{orgId}/payments/{paymentId}/status | Check payment status |
GET | /api/v1/organizations/{orgId}/payments/provider/{paymentId} | Provider-side payment details |
POST | /api/v1/organizations/{orgId}/credits/checkout | Start credit checkout |
POST | /api/v1/organizations/{orgId}/credits/purchase | Purchase credits |
GET | /api/v1/organizations/{orgId}/auto-top-up | Get auto top-up config |
PUT | /api/v1/organizations/{orgId}/auto-top-up | Configure auto top-up |
GET | /api/v1/organizations/{orgId}/payment-method/default | Get default payment method |
POST | /api/v1/organizations/{orgId}/payment-method/setup-session | Start payment method setup |
GET | /api/v1/organizations/{id}/promotions | List active promotions |
Subscribe to, upgrade, or cancel plans. Manage seat counts for your team.
| Method | Endpoint | Description |
|---|---|---|
GET | /api/v1/plans | List all available plans |
GET | /api/v1/organizations/{orgId}/plan | Get current plan |
GET | /api/v1/organizations/{orgId}/plan/history | View plan change history |
GET | /api/v1/organizations/{orgId}/plan/{planId} | Get specific plan details |
POST | /api/v1/organizations/{orgId}/plan | Subscribe to a plan |
PUT | /api/v1/organizations/{orgId}/plan/seats | Update seat count |
DELETE | /api/v1/organizations/{orgId}/plan/{planId} | Cancel a plan |
Track token consumption and costs across your organization.
| Method | Endpoint | Description |
|---|---|---|
GET | /api/v1/organizations/{orgId}/usages | Get aggregated usage data |
Create and manage API keys for programmatic access. Keys created here work with both the Chat Completions API and the endpoints on this page.
| Method | Endpoint | Description |
|---|---|---|
GET | /api/v1/api-keys | List your API keys |
POST | /api/v1/api-keys | Create a new API key |
DELETE | /api/v1/api-keys/{key_id} | Delete an API key |