Clickhouse Customers Retrieve

GET

https://api.respan.ai/clickhouse/customers/:unique_organization_id/

GET

/clickhouse/customers/:unique_organization_id/

$ curl https://api.respan.ai/clickhouse/customers/unique_organization_id/ \
>      -H "Authorization: Bearer <token>"

200Retrieved

1 {
2   "id": "string",
3   "organization_id": "string",
4   "first_seen": "string",
5   "last_active": "string",
6   "total_tokens": 1,
7   "total_requests": 1,
8   "total_cost": 1.1,
9   "organization_subscription": {
10     "id": 1,
11     "api_key_count": 1,
12     "plan_level": 1,
13     "api_key_limit": 1,
14     "log_limit": 1,
15     "current_customer_id": "string",
16     "dataset_size_limit": 1,
17     "credits": [
18       {
19         "id": 1,
20         "expired": true,
21         "created_at": "2024-01-15T09:30:00Z",
22         "amount": 1.1,
23         "currency": "string",
24         "description": "string",
25         "expire_at": "2024-01-15T09:30:00Z",
26         "recurring": true,
27         "hidden_threshold": 1.1,
28         "organization_subscription": 1
29       }
30     ],
31     "active_billing": true,
32     "seats_cost_for_full_period": 1.1,
33     "prompts_cost": 1.1,
34     "free_trial_days_left": 1,
35     "current_period_start_dt": "2024-01-15T09:30:00Z",
36     "current_period_end_dt": "2024-01-15T09:30:00Z",
37     "is_on_free_trial": true,
38     "plan": "string",
39     "mrr": 1.1,
40     "invoice_this_period": 1.1,
41     "invoice_last_period": 1.1,
42     "free_log_limit": 1,
43     "logs_cost_this_period": 1.1,
44     "logs_cost_last_period": 1.1,
45     "member_limit": 1,
46     "member_count": 1,
47     "monthly_seats_cost": 1.1,
48     "current_usage_period_start_dt": "2024-01-15T09:30:00Z",
49     "current_usage_period_end_dt": "2024-01-15T09:30:00Z",
50     "prompt_limit": 1,
51     "evaluator_limit": 1,
52     "dataset_count_limit": 1,
53     "score_limit": 1,
54     "plan_retention_period_in_days": 1,
55     "logs_in_period": 1,
56     "logs_three_months_ago": 1,
57     "keywordsai_llm_credentials_usage_in_period": 1.1,
58     "keywordsai_llm_credentials_usage_last_period": 1.1,
59     "total_cost_with_keywordsai_credentials": 1.1,
60     "created_at": "2024-01-15T09:30:00Z",
61     "log_visibility_cutoff_at": "2024-01-15T09:30:00Z",
62     "subscription_unique_id": "string",
63     "subscribed_at": "2024-01-15T09:30:00Z",
64     "free_trial_end_at": "2024-01-15T09:30:00Z",
65     "deal_id": "string",
66     "monthly_recurring_revenue": 1.1,
67     "expected_annual_contract_value": 1.1,
68     "customer_ids": [
69       "string"
70     ],
71     "metered_item_id": "string",
72     "seat_based_item_id": "string",
73     "base_item_id": "string",
74     "stripe_customer_id": "string",
75     "usage_report_subscription_id": "string",
76     "subscription_id": "string",
77     "current_period_start": 1.1,
78     "current_period_end": 1.1,
79     "current_usage_period_start": 1.1,
80     "current_usage_period_end": 1.1,
81     "usage_in_period": 1.1,
82     "logs_in_last_period": 1,
83     "customer_user_count": 1,
84     "prompt_count": 1,
85     "evals_in_period": 1,
86     "evals_in_last_period": 1,
87     "past_billing_periods": [
88       null
89     ],
90     "last_usage_reported": 1.1,
91     "last_reconciled_at": 1.1,
92     "billing_method": "stripe",
93     "billing_period": "monthly",
94     "usage_report_interval": "monthly",
95     "current_period_invoice_amount": 1.1,
96     "last_period_invoice_amount": 1.1,
97     "budget": 1.1,
98     "credit_balance": 1.1,
99     "custom_log_limit": 1,
100     "custom_plan_name": "string",
101     "custom_monthly_cost": 1.1,
102     "custom_yearly_cost": 1.1,
103     "subscription_bool": true,
104     "accumulative_balance": 1.1,
105     "periodic_invoice_amount": 1.1,
106     "org": 1,
107     "project": "string",
108     "company_organization": 1,
109     "billing_subscription": 1,
110     "organization": 1
111   },
112   "members": [
113     {
114       "id": 1,
115       "access_level": 1,
116       "user": {
117         "id": 1,
118         "email": "string",
119         "name": "string",
120         "has_customized_password": true,
121         "username": "string",
122         "first_name": "string",
123         "last_name": "string",
124         "profile_color": "string"
125       },
126       "organization_name": "string",
127       "user_count": 1,
128       "organization": 1,
129       "email": "",
130       "role": "member",
131       "pending": true,
132       "hidden": true,
133       "permissions_override": [
134         "string"
135       ],
136       "project": "string"
137     }
138   ],
139   "total_member_count": 1,
140   "has_provider_keys": true,
141   "sibling_organizations": [
142     {
143       "id": "string",
144       "name": "string",
145       "unique_organization_id": "string",
146       "logo": "string"
147     }
148   ],
149   "has_api_keys": true,
150   "status": "string",
151   "onboarded": true,
152   "has_api_call_with_non_default_key": true,
153   "onboarding_method": "string",
154   "gateway_onboarding_completed_at": "string",
155   "tracing_onboarding_completed_at": "string",
156   "onboarding_integration_options": {},
157   "fallback_model_enabled": true,
158   "fallback_models": [
159     "string"
160   ],
161   "system_fallback_enabled": true,
162   "retry_enabled": true,
163   "num_retries": 1,
164   "total_logging_cost": 1.1,
165   "unique_organization_id": "string",
166   "owner_email": "string",
167   "organization_name": "string",
168   "stripe_customer_identifier": "string",
169   "user_count": 1,
170   "plan": "string",
171   "is_blocked": true,
172   "disable_log": true,
173   "starred": true,
174   "active_days": 1,
175   "credit_balance": 1.1
176 }

Retrieve a single organization (customer) by ID. Supports both JWT and API key authentication. Requires superadmin access (is_superadmin=True).

Authentication

AuthorizationBearer

JWT access token or Respan API key

Path parameters

unique_organization_idstringRequired

Response

idstring

organization_idstring

first_seenstring

last_activestring

total_tokensinteger

total_requestsinteger

total_costdouble

organization_subscriptionobject

memberslist of objectsRead-only

total_member_countinteger

has_provider_keysbooleanRead-only

sibling_organizationslist of objectsRead-only

has_api_keysbooleanRead-only

statusstring or nullRead-only

onboardedbooleanRead-only

has_api_call_with_non_default_keybooleanRead-only

onboarding_methodstring or nullRead-only

gateway_onboarding_completed_atstring or nullRead-only

tracing_onboarding_completed_atstring or nullRead-only

onboarding_integration_optionsmap from strings to anyRead-only

fallback_model_enabledbooleanRead-only

fallback_modelslist of stringsRead-only

system_fallback_enabledbooleanRead-only

retry_enabledbooleanRead-only

num_retriesintegerRead-only

total_logging_costdoubleRead-only

unique_organization_idstringOptional

owner_emailstringOptional

organization_namestringOptional

stripe_customer_identifierstringOptional

user_countintegerOptional

planstringOptional

is_blockedbooleanOptional

disable_logbooleanOptional

starredbooleanOptional

active_daysintegerOptional

credit_balancedouble or nullOptional