List company overrides

GET

https://api.schematichq.com/company-overrides

GET

/company-overrides

1 import { SchematicClient } from "@schematichq/schematic-typescript-node";
2 
3 const client = new SchematicClient({ apiKey: "YOUR_API_KEY" });
4 await client.entitlements.listCompanyOverrides({
5     companyId: "company_id",
6     featureId: "feature_id",
7     withoutExpired: true,
8     q: "q",
9     limit: 1,
10     offset: 1
11 });

Try it

1 {
2   "data": [
3     {
4       "company_id": "string",
5       "created_at": "2024-01-15T09:30:00Z",
6       "environment_id": "string",
7       "feature_id": "string",
8       "id": "string",
9       "notes": [
10         {
11           "created_at": "2024-01-15T09:30:00Z",
12           "external_user_id": "string",
13           "external_user_name": "string",
14           "id": "string",
15           "note": "string",
16           "updated_at": "2024-01-15T09:30:00Z"
17         }
18       ],
19       "updated_at": "2024-01-15T09:30:00Z",
20       "value_type": "string",
21       "company": {
22         "add_ons": [
23           {
24             "id": "string",
25             "name": "string",
26             "added_on": "2024-01-15T09:30:00Z",
27             "billing_product_external_id": "string",
28             "billing_product_id": "string",
29             "description": "string",
30             "image_url": "string",
31             "plan_period": "string",
32             "plan_price": 1
33           }
34         ],
35         "billing_subscriptions": [
36           {
37             "cancel_at_period_end": true,
38             "created_at": "2024-01-15T09:30:00Z",
39             "currency": "string",
40             "customer_external_id": "string",
41             "discounts": [
42               {
43                 "coupon_id": "string",
44                 "coupon_name": "string",
45                 "discount_external_id": "string",
46                 "duration": "string",
47                 "is_active": true,
48                 "started_at": "2024-01-15T09:30:00Z",
49                 "subscription_external_id": "string",
50                 "amount_off": 1,
51                 "currency": "string",
52                 "customer_facing_code": "string",
53                 "duration_in_months": 1,
54                 "ended_at": "2024-01-15T09:30:00Z",
55                 "percent_off": 1.1,
56                 "promo_code_external_id": "string"
57               }
58             ],
59             "id": "string",
60             "interval": "string",
61             "period_end": 1,
62             "period_start": 1,
63             "products": [
64               {
65                 "billing_scheme": "string",
66                 "created_at": "2024-01-15T09:30:00Z",
67                 "currency": "string",
68                 "environment_id": "string",
69                 "external_id": "string",
70                 "id": "string",
71                 "interval": "string",
72                 "name": "string",
73                 "package_size": 1,
74                 "price": 1,
75                 "price_external_id": "string",
76                 "price_id": "string",
77                 "price_tier": [
78                   {
79                     "flat_amount": 1,
80                     "per_unit_price": 1,
81                     "per_unit_price_decimal": "string",
82                     "up_to": 1
83                   }
84                 ],
85                 "quantity": 1.1,
86                 "subscription_id": "string",
87                 "updated_at": "2024-01-15T09:30:00Z",
88                 "usage_type": "string",
89                 "billing_threshold": 1,
90                 "meter_id": "string",
91                 "price_decimal": "string",
92                 "subscription_item_external_id": "string"
93               }
94             ],
95             "status": "string",
96             "subscription_external_id": "string",
97             "total_price": 1,
98             "cancel_at": 1,
99             "company_id": "string",
100             "default_payment_method_id": "string",
101             "expired_at": "2024-01-15T09:30:00Z",
102             "latest_invoice": {
103               "amount_due": 1,
104               "amount_paid": 1,
105               "amount_remaining": 1,
106               "collection_method": "string",
107               "created_at": "2024-01-15T09:30:00Z",
108               "currency": "string",
109               "customer_external_id": "string",
110               "environment_id": "string",
111               "id": "string",
112               "subtotal": 1,
113               "updated_at": "2024-01-15T09:30:00Z",
114               "company_id": "string",
115               "due_date": "2024-01-15T09:30:00Z",
116               "external_id": "string",
117               "payment_method_external_id": "string",
118               "subscription_external_id": "string",
119               "url": "string"
120             },
121             "metadata": {},
122             "payment_method": {
123               "created_at": "2024-01-15T09:30:00Z",
124               "customer_external_id": "string",
125               "environment_id": "string",
126               "external_id": "string",
127               "id": "string",
128               "payment_method_type": "string",
129               "updated_at": "2024-01-15T09:30:00Z",
130               "account_last4": "string",
131               "account_name": "string",
132               "bank_name": "string",
133               "billing_email": "string",
134               "billing_name": "string",
135               "card_brand": "string",
136               "card_exp_month": 1,
137               "card_exp_year": 1,
138               "card_last4": "string",
139               "company_id": "string"
140             },
141             "trial_end": 1,
142             "trial_end_setting": "string"
143           }
144         ],
145         "created_at": "2024-01-15T09:30:00Z",
146         "entity_traits": [
147           {
148             "created_at": "2024-01-15T09:30:00Z",
149             "definition_id": "string",
150             "environment_id": "string",
151             "id": "string",
152             "updated_at": "2024-01-15T09:30:00Z",
153             "value": "string",
154             "definition": {
155               "created_at": "2024-01-15T09:30:00Z",
156               "display_name": "string",
157               "entity_type": "string",
158               "hierarchy": [
159                 "string"
160               ],
161               "id": "string",
162               "trait_type": "string",
163               "updated_at": "2024-01-15T09:30:00Z"
164             }
165           }
166         ],
167         "environment_id": "string",
168         "id": "string",
169         "keys": [
170           {
171             "created_at": "2024-01-15T09:30:00Z",
172             "definition_id": "string",
173             "entity_id": "string",
174             "entity_type": "string",
175             "environment_id": "string",
176             "id": "string",
177             "key": "string",
178             "updated_at": "2024-01-15T09:30:00Z",
179             "value": "string",
180             "definition": {
181               "created_at": "2024-01-15T09:30:00Z",
182               "entity_type": "string",
183               "id": "string",
184               "key": "string",
185               "updated_at": "2024-01-15T09:30:00Z"
186             }
187           }
188         ],
189         "metrics": [
190           {
191             "account_id": "string",
192             "captured_at_max": "2024-01-15T09:30:00Z",
193             "captured_at_min": "2024-01-15T09:30:00Z",
194             "company_id": "string",
195             "created_at": "2024-01-15T09:30:00Z",
196             "environment_id": "string",
197             "event_subtype": "string",
198             "month_reset": "string",
199             "period": "string",
200             "value": 1,
201             "valid_until": "2024-01-15T09:30:00Z"
202           }
203         ],
204         "name": "string",
205         "payment_methods": [
206           {
207             "created_at": "2024-01-15T09:30:00Z",
208             "customer_external_id": "string",
209             "environment_id": "string",
210             "external_id": "string",
211             "id": "string",
212             "payment_method_type": "string",
213             "updated_at": "2024-01-15T09:30:00Z",
214             "account_last4": "string",
215             "account_name": "string",
216             "bank_name": "string",
217             "billing_email": "string",
218             "billing_name": "string",
219             "card_brand": "string",
220             "card_exp_month": 1,
221             "card_exp_year": 1,
222             "card_last4": "string",
223             "company_id": "string"
224           }
225         ],
226         "plans": [
227           {
228             "id": "string",
229             "name": "string",
230             "description": "string",
231             "image_url": "string"
232           }
233         ],
234         "rules": [
235           {
236             "account_id": "string",
237             "condition_groups": [
238               {
239                 "conditions": [
240                   {
241                     "account_id": "string",
242                     "condition_type": "string",
243                     "environment_id": "string",
244                     "id": "string",
245                     "operator": "string",
246                     "resource_ids": [
247                       "string"
248                     ],
249                     "trait_value": "string",
250                     "comparison_trait_definition": {
251                       "comparable_type": "string",
252                       "entity_type": "string",
253                       "id": "string"
254                     },
255                     "consumption_rate": 1.1,
256                     "credit_id": "string",
257                     "event_subtype": "string",
258                     "metric_period": "string",
259                     "metric_period_month_reset": "string",
260                     "metric_value": 1,
261                     "trait_definition": {
262                       "comparable_type": "string",
263                       "entity_type": "string",
264                       "id": "string"
265                     }
266                   }
267                 ]
268               }
269             ],
270             "conditions": [
271               {
272                 "account_id": "string",
273                 "condition_type": "string",
274                 "environment_id": "string",
275                 "id": "string",
276                 "operator": "string",
277                 "resource_ids": [
278                   "string"
279                 ],
280                 "trait_value": "string",
281                 "comparison_trait_definition": {
282                   "comparable_type": "string",
283                   "entity_type": "string",
284                   "id": "string"
285                 },
286                 "consumption_rate": 1.1,
287                 "credit_id": "string",
288                 "event_subtype": "string",
289                 "metric_period": "string",
290                 "metric_period_month_reset": "string",
291                 "metric_value": 1,
292                 "trait_definition": {
293                   "comparable_type": "string",
294                   "entity_type": "string",
295                   "id": "string"
296                 }
297               }
298             ],
299             "environment_id": "string",
300             "id": "string",
301             "name": "string",
302             "priority": 1,
303             "rule_type": "string",
304             "value": true,
305             "flag_id": "string"
306           }
307         ],
308         "updated_at": "2024-01-15T09:30:00Z",
309         "user_count": 1,
310         "billing_credit_balances": {},
311         "billing_subscription": {
312           "cancel_at_period_end": true,
313           "created_at": "2024-01-15T09:30:00Z",
314           "currency": "string",
315           "customer_external_id": "string",
316           "discounts": [
317             {
318               "coupon_id": "string",
319               "coupon_name": "string",
320               "discount_external_id": "string",
321               "duration": "string",
322               "is_active": true,
323               "started_at": "2024-01-15T09:30:00Z",
324               "subscription_external_id": "string",
325               "amount_off": 1,
326               "currency": "string",
327               "customer_facing_code": "string",
328               "duration_in_months": 1,
329               "ended_at": "2024-01-15T09:30:00Z",
330               "percent_off": 1.1,
331               "promo_code_external_id": "string"
332             }
333           ],
334           "id": "string",
335           "interval": "string",
336           "period_end": 1,
337           "period_start": 1,
338           "products": [
339             {
340               "billing_scheme": "string",
341               "created_at": "2024-01-15T09:30:00Z",
342               "currency": "string",
343               "environment_id": "string",
344               "external_id": "string",
345               "id": "string",
346               "interval": "string",
347               "name": "string",
348               "package_size": 1,
349               "price": 1,
350               "price_external_id": "string",
351               "price_id": "string",
352               "price_tier": [
353                 {
354                   "flat_amount": 1,
355                   "per_unit_price": 1,
356                   "per_unit_price_decimal": "string",
357                   "up_to": 1
358                 }
359               ],
360               "quantity": 1.1,
361               "subscription_id": "string",
362               "updated_at": "2024-01-15T09:30:00Z",
363               "usage_type": "string",
364               "billing_threshold": 1,
365               "meter_id": "string",
366               "price_decimal": "string",
367               "subscription_item_external_id": "string"
368             }
369           ],
370           "status": "string",
371           "subscription_external_id": "string",
372           "total_price": 1,
373           "cancel_at": 1,
374           "company_id": "string",
375           "default_payment_method_id": "string",
376           "expired_at": "2024-01-15T09:30:00Z",
377           "latest_invoice": {
378             "amount_due": 1,
379             "amount_paid": 1,
380             "amount_remaining": 1,
381             "collection_method": "string",
382             "created_at": "2024-01-15T09:30:00Z",
383             "currency": "string",
384             "customer_external_id": "string",
385             "environment_id": "string",
386             "id": "string",
387             "subtotal": 1,
388             "updated_at": "2024-01-15T09:30:00Z",
389             "company_id": "string",
390             "due_date": "2024-01-15T09:30:00Z",
391             "external_id": "string",
392             "payment_method_external_id": "string",
393             "subscription_external_id": "string",
394             "url": "string"
395           },
396           "metadata": {},
397           "payment_method": {
398             "created_at": "2024-01-15T09:30:00Z",
399             "customer_external_id": "string",
400             "environment_id": "string",
401             "external_id": "string",
402             "id": "string",
403             "payment_method_type": "string",
404             "updated_at": "2024-01-15T09:30:00Z",
405             "account_last4": "string",
406             "account_name": "string",
407             "bank_name": "string",
408             "billing_email": "string",
409             "billing_name": "string",
410             "card_brand": "string",
411             "card_exp_month": 1,
412             "card_exp_year": 1,
413             "card_last4": "string",
414             "company_id": "string"
415           },
416           "trial_end": 1,
417           "trial_end_setting": "string"
418         },
419         "default_payment_method": {
420           "created_at": "2024-01-15T09:30:00Z",
421           "customer_external_id": "string",
422           "environment_id": "string",
423           "external_id": "string",
424           "id": "string",
425           "payment_method_type": "string",
426           "updated_at": "2024-01-15T09:30:00Z",
427           "account_last4": "string",
428           "account_name": "string",
429           "bank_name": "string",
430           "billing_email": "string",
431           "billing_name": "string",
432           "card_brand": "string",
433           "card_exp_month": 1,
434           "card_exp_year": 1,
435           "card_last4": "string",
436           "company_id": "string"
437         },
438         "last_seen_at": "2024-01-15T09:30:00Z",
439         "logo_url": "string",
440         "plan": {
441           "id": "string",
442           "name": "string",
443           "added_on": "2024-01-15T09:30:00Z",
444           "billing_product_external_id": "string",
445           "billing_product_id": "string",
446           "description": "string",
447           "image_url": "string",
448           "plan_period": "string",
449           "plan_price": 1
450         },
451         "traits": {}
452       },
453       "consumption_rate": 1.1,
454       "expiration_date": "2024-01-15T09:30:00Z",
455       "feature": {
456         "created_at": "2024-01-15T09:30:00Z",
457         "description": "string",
458         "feature_type": "string",
459         "icon": "string",
460         "id": "string",
461         "name": "string",
462         "updated_at": "2024-01-15T09:30:00Z",
463         "event_subtype": "string",
464         "lifecycle_phase": "string",
465         "maintainer_id": "string",
466         "plural_name": "string",
467         "singular_name": "string",
468         "trait_id": "string"
469       },
470       "metric_period": "string",
471       "metric_period_month_reset": "string",
472       "rule_id": "string",
473       "rule_id_usage_exceeded": "string",
474       "value_bool": true,
475       "value_numeric": 1,
476       "value_trait": {
477         "created_at": "2024-01-15T09:30:00Z",
478         "display_name": "string",
479         "entity_type": "string",
480         "hierarchy": [
481           "string"
482         ],
483         "id": "string",
484         "trait_type": "string",
485         "updated_at": "2024-01-15T09:30:00Z"
486       },
487       "value_trait_id": "string"
488     }
489   ],
490   "params": {
491     "company_id": "string",
492     "company_ids": [
493       "string"
494     ],
495     "feature_id": "string",
496     "feature_ids": [
497       "string"
498     ],
499     "ids": [
500       "string"
501     ],
502     "limit": "100",
503     "offset": "0",
504     "q": "string",
505     "without_expired": true
506   }
507 }

Authentication

X-Schematic-Api-Keystring

API Key authentication via header

Query parameters

company_idstringOptional

Filter company overrides by a single company ID (starting with comp_)

company_idslist of stringsOptional

Filter company overrides by multiple company IDs (starting with comp_)

feature_idstringOptional

Filter company overrides by a single feature ID (starting with feat_)

feature_idslist of stringsOptional

Filter company overrides by multiple feature IDs (starting with feat_)

idslist of stringsOptional

Filter company overrides by multiple company override IDs (starting with cmov_)

without_expiredbooleanOptional

Filter company overrides by whether they have not expired

qstringOptional

Search for company overrides by feature or company name

limitintegerOptional

Page limit (default 100)

offsetintegerOptional

Page offset (default 0)

Response

datalist of objects

paramsobject

Input parameters

Authentication

Query parameters

Response

Errors