List company overrides

GET

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

GET

/company-overrides

1 import { SchematicClient } from "@schematichq/schematic-typescript-node";
2 
3 async function main() {
4     const client = new SchematicClient({
5         apiKey: "YOUR_API_KEY_HERE",
6     });
7     await client.entitlements.listCompanyOverrides({});
8 }
9 main();

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": "boolean",
21       "company": {
22         "add_ons": [
23           {
24             "id": "string",
25             "included_credit_grants": [
26               {
27                 "billing_credit_auto_topup_enabled": true,
28                 "created_at": "2024-01-15T09:30:00Z",
29                 "credit_amount": 1,
30                 "credit_id": "string",
31                 "id": "string",
32                 "plan_id": "string",
33                 "reset_type": "no_reset",
34                 "updated_at": "2024-01-15T09:30:00Z",
35                 "credit_description": "string",
36                 "credit_name": "string",
37                 "billing_credit_auto_topup_amount": 1,
38                 "billing_credit_auto_topup_amount_type": "string",
39                 "billing_credit_auto_topup_expiry_type": "duration",
40                 "billing_credit_auto_topup_expiry_unit": "billing_periods",
41                 "billing_credit_auto_topup_expiry_unit_count": 1,
42                 "billing_credit_auto_topup_threshold_percent": 1,
43                 "credit": {
44                   "account_id": "string",
45                   "burn_strategy": "expiration_priority",
46                   "cost_editable": true,
47                   "created_at": "2024-01-15T09:30:00Z",
48                   "default_expiry_unit": "billing_periods",
49                   "default_rollover_policy": "expire",
50                   "description": "string",
51                   "environment_id": "string",
52                   "id": "string",
53                   "name": "string",
54                   "updated_at": "2024-01-15T09:30:00Z",
55                   "default_expiry_unit_count": 1,
56                   "icon": "string",
57                   "plural_name": "string",
58                   "price": {
59                     "billing_scheme": "per_unit",
60                     "created_at": "2024-01-15T09:30:00Z",
61                     "currency": "string",
62                     "id": "string",
63                     "interval": "day",
64                     "is_active": true,
65                     "package_size": 1,
66                     "price": 1,
67                     "price_external_id": "string",
68                     "price_id": "string",
69                     "price_tier": [
70                       {
71                         "flat_amount": 1,
72                         "per_unit_price": 1,
73                         "per_unit_price_decimal": "string",
74                         "up_to": 1
75                       }
76                     ],
77                     "product_external_id": "string",
78                     "product_id": "string",
79                     "product_name": "string",
80                     "provider_type": "schematic",
81                     "updated_at": "2024-01-15T09:30:00Z",
82                     "usage_type": "licensed",
83                     "meter_event_name": "string",
84                     "meter_event_payload_key": "string",
85                     "meter_id": "string",
86                     "price_decimal": "string",
87                     "tiers_mode": "graduated"
88                   },
89                   "price_per_unit": 1,
90                   "price_per_unit_decimal": "string",
91                   "product": {
92                     "account_id": "string",
93                     "created_at": "2024-01-15T09:30:00Z",
94                     "environment_id": "string",
95                     "external_id": "string",
96                     "is_active": true,
97                     "name": "string",
98                     "price": 1.1,
99                     "product_id": "string",
100                     "provider_type": "schematic",
101                     "quantity": 1.1,
102                     "updated_at": "2024-01-15T09:30:00Z",
103                     "price_decimal": "string",
104                     "currency": "string"
105                   },
106                   "singular_name": "string"
107                 },
108                 "expiry_type": "duration",
109                 "expiry_unit": "billing_periods",
110                 "expiry_unit_count": 1,
111                 "plan": {
112                   "id": "string",
113                   "name": "string",
114                   "description": "string",
115                   "image_url": "string"
116                 },
117                 "plan_version_id": "string",
118                 "reset_cadence": "daily",
119                 "reset_start": "billing_period",
120                 "credit_icon": "string",
121                 "plural_name": "string",
122                 "singular_name": "string"
123               }
124             ],
125             "name": "string",
126             "added_on": "2024-01-15T09:30:00Z",
127             "billing_product_external_id": "string",
128             "billing_product_id": "string",
129             "description": "string",
130             "image_url": "string",
131             "plan_period": "string",
132             "plan_price": 1,
133             "plan_version_id": "string"
134           }
135         ],
136         "billing_subscriptions": [
137           {
138             "cancel_at_period_end": true,
139             "created_at": "2024-01-15T09:30:00Z",
140             "currency": "string",
141             "customer_external_id": "string",
142             "discounts": [
143               {
144                 "coupon_id": "string",
145                 "coupon_name": "string",
146                 "discount_external_id": "string",
147                 "duration": "string",
148                 "is_active": true,
149                 "started_at": "2024-01-15T09:30:00Z",
150                 "subscription_external_id": "string",
151                 "amount_off": 1,
152                 "currency": "string",
153                 "customer_facing_code": "string",
154                 "duration_in_months": 1,
155                 "ended_at": "2024-01-15T09:30:00Z",
156                 "percent_off": 1.1,
157                 "promo_code_external_id": "string"
158               }
159             ],
160             "id": "string",
161             "interval": "string",
162             "period_end": 1,
163             "period_start": 1,
164             "products": [
165               {
166                 "billing_scheme": "per_unit",
167                 "created_at": "2024-01-15T09:30:00Z",
168                 "currency": "string",
169                 "environment_id": "string",
170                 "external_id": "string",
171                 "id": "string",
172                 "interval": "string",
173                 "name": "string",
174                 "package_size": 1,
175                 "price": 1,
176                 "price_external_id": "string",
177                 "price_id": "string",
178                 "price_tier": [
179                   {
180                     "flat_amount": 1,
181                     "per_unit_price": 1,
182                     "per_unit_price_decimal": "string",
183                     "up_to": 1
184                   }
185                 ],
186                 "provider_type": "schematic",
187                 "quantity": 1.1,
188                 "subscription_id": "string",
189                 "updated_at": "2024-01-15T09:30:00Z",
190                 "usage_type": "licensed",
191                 "billing_threshold": 1,
192                 "meter_id": "string",
193                 "price_decimal": "string",
194                 "subscription_item_external_id": "string"
195               }
196             ],
197             "provider_type": "schematic",
198             "status": "string",
199             "subscription_external_id": "string",
200             "total_price": 1,
201             "application_id": "string",
202             "cancel_at": 1,
203             "company_id": "string",
204             "default_payment_method_id": "string",
205             "expired_at": "2024-01-15T09:30:00Z",
206             "latest_invoice": {
207               "amount_due": 1,
208               "amount_paid": 1,
209               "amount_remaining": 1,
210               "collection_method": "string",
211               "created_at": "2024-01-15T09:30:00Z",
212               "currency": "string",
213               "customer_external_id": "string",
214               "environment_id": "string",
215               "id": "string",
216               "provider_type": "schematic",
217               "subtotal": 1,
218               "updated_at": "2024-01-15T09:30:00Z",
219               "company_id": "string",
220               "due_date": "2024-01-15T09:30:00Z",
221               "external_id": "string",
222               "payment_method_external_id": "string",
223               "status": "draft",
224               "subscription_external_id": "string",
225               "url": "string"
226             },
227             "metadata": {},
228             "payment_method": {
229               "created_at": "2024-01-15T09:30:00Z",
230               "customer_external_id": "string",
231               "environment_id": "string",
232               "external_id": "string",
233               "id": "string",
234               "payment_method_type": "string",
235               "provider_type": "schematic",
236               "updated_at": "2024-01-15T09:30:00Z",
237               "account_last4": "string",
238               "account_name": "string",
239               "bank_name": "string",
240               "billing_email": "string",
241               "billing_name": "string",
242               "card_brand": "string",
243               "card_exp_month": 1,
244               "card_exp_year": 1,
245               "card_last4": "string",
246               "company_id": "string"
247             },
248             "trial_end": 1,
249             "trial_end_setting": "cancel"
250           }
251         ],
252         "created_at": "2024-01-15T09:30:00Z",
253         "entitlements": [
254           {
255             "feature_id": "string",
256             "feature_key": "string",
257             "value_type": "boolean",
258             "allocation": 1,
259             "credit_id": "string",
260             "credit_remaining": 1.1,
261             "credit_total": 1.1,
262             "credit_used": 1.1,
263             "event_name": "string",
264             "metric_period": "all_time",
265             "metric_reset_at": "2024-01-15T09:30:00Z",
266             "month_reset": "first_of_month",
267             "soft_limit": 1,
268             "usage": 1
269           }
270         ],
271         "entity_traits": [
272           {
273             "created_at": "2024-01-15T09:30:00Z",
274             "definition_id": "string",
275             "environment_id": "string",
276             "id": "string",
277             "updated_at": "2024-01-15T09:30:00Z",
278             "value": "string",
279             "definition": {
280               "created_at": "2024-01-15T09:30:00Z",
281               "display_name": "string",
282               "entity_type": "company",
283               "hierarchy": [
284                 "string"
285               ],
286               "id": "string",
287               "trait_type": "boolean",
288               "updated_at": "2024-01-15T09:30:00Z"
289             }
290           }
291         ],
292         "environment_id": "string",
293         "id": "string",
294         "keys": [
295           {
296             "created_at": "2024-01-15T09:30:00Z",
297             "definition_id": "string",
298             "entity_id": "string",
299             "entity_type": "company",
300             "environment_id": "string",
301             "id": "string",
302             "key": "string",
303             "updated_at": "2024-01-15T09:30:00Z",
304             "value": "string",
305             "definition": {
306               "created_at": "2024-01-15T09:30:00Z",
307               "entity_type": "company",
308               "id": "string",
309               "key": "string",
310               "updated_at": "2024-01-15T09:30:00Z"
311             }
312           }
313         ],
314         "metrics": [
315           {
316             "account_id": "string",
317             "captured_at_max": "2024-01-15T09:30:00Z",
318             "captured_at_min": "2024-01-15T09:30:00Z",
319             "company_id": "string",
320             "created_at": "2024-01-15T09:30:00Z",
321             "environment_id": "string",
322             "event_subtype": "string",
323             "month_reset": "string",
324             "period": "string",
325             "value": 1,
326             "valid_until": "2024-01-15T09:30:00Z"
327           }
328         ],
329         "name": "string",
330         "payment_methods": [
331           {
332             "created_at": "2024-01-15T09:30:00Z",
333             "customer_external_id": "string",
334             "environment_id": "string",
335             "external_id": "string",
336             "id": "string",
337             "payment_method_type": "string",
338             "provider_type": "schematic",
339             "updated_at": "2024-01-15T09:30:00Z",
340             "account_last4": "string",
341             "account_name": "string",
342             "bank_name": "string",
343             "billing_email": "string",
344             "billing_name": "string",
345             "card_brand": "string",
346             "card_exp_month": 1,
347             "card_exp_year": 1,
348             "card_last4": "string",
349             "company_id": "string"
350           }
351         ],
352         "plans": [
353           {
354             "id": "string",
355             "name": "string",
356             "description": "string",
357             "image_url": "string"
358           }
359         ],
360         "rules": [
361           {
362             "account_id": "string",
363             "condition_groups": [
364               {
365                 "conditions": [
366                   {
367                     "account_id": "string",
368                     "condition_type": "base_plan",
369                     "environment_id": "string",
370                     "id": "string",
371                     "operator": "eq",
372                     "resource_ids": [
373                       "string"
374                     ],
375                     "trait_value": "string",
376                     "comparison_trait_definition": {
377                       "comparable_type": "bool",
378                       "entity_type": "company",
379                       "id": "string"
380                     },
381                     "consumption_rate": 1.1,
382                     "credit_id": "string",
383                     "event_subtype": "string",
384                     "metric_period": "all_time",
385                     "metric_period_month_reset": "first_of_month",
386                     "metric_value": 1,
387                     "trait_definition": {
388                       "comparable_type": "bool",
389                       "entity_type": "company",
390                       "id": "string"
391                     }
392                   }
393                 ]
394               }
395             ],
396             "conditions": [
397               {
398                 "account_id": "string",
399                 "condition_type": "base_plan",
400                 "environment_id": "string",
401                 "id": "string",
402                 "operator": "eq",
403                 "resource_ids": [
404                   "string"
405                 ],
406                 "trait_value": "string",
407                 "comparison_trait_definition": {
408                   "comparable_type": "bool",
409                   "entity_type": "company",
410                   "id": "string"
411                 },
412                 "consumption_rate": 1.1,
413                 "credit_id": "string",
414                 "event_subtype": "string",
415                 "metric_period": "all_time",
416                 "metric_period_month_reset": "first_of_month",
417                 "metric_value": 1,
418                 "trait_definition": {
419                   "comparable_type": "bool",
420                   "entity_type": "company",
421                   "id": "string"
422                 }
423               }
424             ],
425             "environment_id": "string",
426             "id": "string",
427             "name": "string",
428             "priority": 1,
429             "rule_type": "default",
430             "value": true,
431             "flag_id": "string"
432           }
433         ],
434         "updated_at": "2024-01-15T09:30:00Z",
435         "user_count": 1,
436         "billing_credit_balances": {},
437         "billing_subscription": {
438           "cancel_at_period_end": true,
439           "created_at": "2024-01-15T09:30:00Z",
440           "currency": "string",
441           "customer_external_id": "string",
442           "discounts": [
443             {
444               "coupon_id": "string",
445               "coupon_name": "string",
446               "discount_external_id": "string",
447               "duration": "string",
448               "is_active": true,
449               "started_at": "2024-01-15T09:30:00Z",
450               "subscription_external_id": "string",
451               "amount_off": 1,
452               "currency": "string",
453               "customer_facing_code": "string",
454               "duration_in_months": 1,
455               "ended_at": "2024-01-15T09:30:00Z",
456               "percent_off": 1.1,
457               "promo_code_external_id": "string"
458             }
459           ],
460           "id": "string",
461           "interval": "string",
462           "period_end": 1,
463           "period_start": 1,
464           "products": [
465             {
466               "billing_scheme": "per_unit",
467               "created_at": "2024-01-15T09:30:00Z",
468               "currency": "string",
469               "environment_id": "string",
470               "external_id": "string",
471               "id": "string",
472               "interval": "string",
473               "name": "string",
474               "package_size": 1,
475               "price": 1,
476               "price_external_id": "string",
477               "price_id": "string",
478               "price_tier": [
479                 {
480                   "flat_amount": 1,
481                   "per_unit_price": 1,
482                   "per_unit_price_decimal": "string",
483                   "up_to": 1
484                 }
485               ],
486               "provider_type": "schematic",
487               "quantity": 1.1,
488               "subscription_id": "string",
489               "updated_at": "2024-01-15T09:30:00Z",
490               "usage_type": "licensed",
491               "billing_threshold": 1,
492               "meter_id": "string",
493               "price_decimal": "string",
494               "subscription_item_external_id": "string"
495             }
496           ],
497           "provider_type": "schematic",
498           "status": "string",
499           "subscription_external_id": "string",
500           "total_price": 1,
501           "application_id": "string",
502           "cancel_at": 1,
503           "company_id": "string",
504           "default_payment_method_id": "string",
505           "expired_at": "2024-01-15T09:30:00Z",
506           "latest_invoice": {
507             "amount_due": 1,
508             "amount_paid": 1,
509             "amount_remaining": 1,
510             "collection_method": "string",
511             "created_at": "2024-01-15T09:30:00Z",
512             "currency": "string",
513             "customer_external_id": "string",
514             "environment_id": "string",
515             "id": "string",
516             "provider_type": "schematic",
517             "subtotal": 1,
518             "updated_at": "2024-01-15T09:30:00Z",
519             "company_id": "string",
520             "due_date": "2024-01-15T09:30:00Z",
521             "external_id": "string",
522             "payment_method_external_id": "string",
523             "status": "draft",
524             "subscription_external_id": "string",
525             "url": "string"
526           },
527           "metadata": {},
528           "payment_method": {
529             "created_at": "2024-01-15T09:30:00Z",
530             "customer_external_id": "string",
531             "environment_id": "string",
532             "external_id": "string",
533             "id": "string",
534             "payment_method_type": "string",
535             "provider_type": "schematic",
536             "updated_at": "2024-01-15T09:30:00Z",
537             "account_last4": "string",
538             "account_name": "string",
539             "bank_name": "string",
540             "billing_email": "string",
541             "billing_name": "string",
542             "card_brand": "string",
543             "card_exp_month": 1,
544             "card_exp_year": 1,
545             "card_last4": "string",
546             "company_id": "string"
547           },
548           "trial_end": 1,
549           "trial_end_setting": "cancel"
550         },
551         "default_payment_method": {
552           "created_at": "2024-01-15T09:30:00Z",
553           "customer_external_id": "string",
554           "environment_id": "string",
555           "external_id": "string",
556           "id": "string",
557           "payment_method_type": "string",
558           "provider_type": "schematic",
559           "updated_at": "2024-01-15T09:30:00Z",
560           "account_last4": "string",
561           "account_name": "string",
562           "bank_name": "string",
563           "billing_email": "string",
564           "billing_name": "string",
565           "card_brand": "string",
566           "card_exp_month": 1,
567           "card_exp_year": 1,
568           "card_last4": "string",
569           "company_id": "string"
570         },
571         "last_seen_at": "2024-01-15T09:30:00Z",
572         "logo_url": "string",
573         "plan": {
574           "id": "string",
575           "included_credit_grants": [
576             {
577               "billing_credit_auto_topup_enabled": true,
578               "created_at": "2024-01-15T09:30:00Z",
579               "credit_amount": 1,
580               "credit_id": "string",
581               "id": "string",
582               "plan_id": "string",
583               "reset_type": "no_reset",
584               "updated_at": "2024-01-15T09:30:00Z",
585               "credit_description": "string",
586               "credit_name": "string",
587               "billing_credit_auto_topup_amount": 1,
588               "billing_credit_auto_topup_amount_type": "string",
589               "billing_credit_auto_topup_expiry_type": "duration",
590               "billing_credit_auto_topup_expiry_unit": "billing_periods",
591               "billing_credit_auto_topup_expiry_unit_count": 1,
592               "billing_credit_auto_topup_threshold_percent": 1,
593               "credit": {
594                 "account_id": "string",
595                 "burn_strategy": "expiration_priority",
596                 "cost_editable": true,
597                 "created_at": "2024-01-15T09:30:00Z",
598                 "default_expiry_unit": "billing_periods",
599                 "default_rollover_policy": "expire",
600                 "description": "string",
601                 "environment_id": "string",
602                 "id": "string",
603                 "name": "string",
604                 "updated_at": "2024-01-15T09:30:00Z",
605                 "default_expiry_unit_count": 1,
606                 "icon": "string",
607                 "plural_name": "string",
608                 "price": {
609                   "billing_scheme": "per_unit",
610                   "created_at": "2024-01-15T09:30:00Z",
611                   "currency": "string",
612                   "id": "string",
613                   "interval": "day",
614                   "is_active": true,
615                   "package_size": 1,
616                   "price": 1,
617                   "price_external_id": "string",
618                   "price_id": "string",
619                   "price_tier": [
620                     {
621                       "flat_amount": 1,
622                       "per_unit_price": 1,
623                       "per_unit_price_decimal": "string",
624                       "up_to": 1
625                     }
626                   ],
627                   "product_external_id": "string",
628                   "product_id": "string",
629                   "product_name": "string",
630                   "provider_type": "schematic",
631                   "updated_at": "2024-01-15T09:30:00Z",
632                   "usage_type": "licensed",
633                   "meter_event_name": "string",
634                   "meter_event_payload_key": "string",
635                   "meter_id": "string",
636                   "price_decimal": "string",
637                   "tiers_mode": "graduated"
638                 },
639                 "price_per_unit": 1,
640                 "price_per_unit_decimal": "string",
641                 "product": {
642                   "account_id": "string",
643                   "created_at": "2024-01-15T09:30:00Z",
644                   "environment_id": "string",
645                   "external_id": "string",
646                   "is_active": true,
647                   "name": "string",
648                   "price": 1.1,
649                   "product_id": "string",
650                   "provider_type": "schematic",
651                   "quantity": 1.1,
652                   "updated_at": "2024-01-15T09:30:00Z",
653                   "price_decimal": "string",
654                   "currency": "string"
655                 },
656                 "singular_name": "string"
657               },
658               "expiry_type": "duration",
659               "expiry_unit": "billing_periods",
660               "expiry_unit_count": 1,
661               "plan": {
662                 "id": "string",
663                 "name": "string",
664                 "description": "string",
665                 "image_url": "string"
666               },
667               "plan_version_id": "string",
668               "reset_cadence": "daily",
669               "reset_start": "billing_period",
670               "credit_icon": "string",
671               "plural_name": "string",
672               "singular_name": "string"
673             }
674           ],
675           "name": "string",
676           "added_on": "2024-01-15T09:30:00Z",
677           "billing_product_external_id": "string",
678           "billing_product_id": "string",
679           "description": "string",
680           "image_url": "string",
681           "plan_period": "string",
682           "plan_price": 1,
683           "plan_version_id": "string"
684         },
685         "scheduled_downgrade": {
686           "currency": "string",
687           "effective_after": "2024-01-15T09:30:00Z",
688           "from_plan_id": "string",
689           "from_plan_name": "string",
690           "from_subscription_price": 1,
691           "id": "string",
692           "interval": "string",
693           "to_plan_id": "string",
694           "to_plan_name": "string",
695           "scheduled_interval": "string",
696           "scheduled_price": 1
697         },
698         "traits": {}
699       },
700       "consumption_rate": 1.1,
701       "expiration_date": "2024-01-15T09:30:00Z",
702       "feature": {
703         "created_at": "2024-01-15T09:30:00Z",
704         "description": "string",
705         "feature_type": "boolean",
706         "icon": "string",
707         "id": "string",
708         "name": "string",
709         "updated_at": "2024-01-15T09:30:00Z",
710         "event_subtype": "string",
711         "lifecycle_phase": "add_on",
712         "maintainer_id": "string",
713         "plural_name": "string",
714         "singular_name": "string",
715         "trait_id": "string"
716       },
717       "metric_period": "string",
718       "metric_period_month_reset": "string",
719       "rule_id": "string",
720       "rule_id_usage_exceeded": "string",
721       "value_bool": true,
722       "value_numeric": 1,
723       "value_trait": {
724         "created_at": "2024-01-15T09:30:00Z",
725         "display_name": "string",
726         "entity_type": "company",
727         "hierarchy": [
728           "string"
729         ],
730         "id": "string",
731         "trait_type": "boolean",
732         "updated_at": "2024-01-15T09:30:00Z"
733       },
734       "value_trait_id": "string"
735     }
736   ],
737   "params": {
738     "company_id": "string",
739     "company_ids": [
740       "string"
741     ],
742     "feature_id": "string",
743     "feature_ids": [
744       "string"
745     ],
746     "ids": [
747       "string"
748     ],
749     "limit": 100,
750     "offset": 0,
751     "q": "string",
752     "without_expired": true
753   }
754 }

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

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error