Update company override

PUT

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

PUT

/company-overrides/:company_override_id

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.updateCompanyOverride("company_override_id", {
8         valueType: "boolean",
9     });
10 }
11 main();

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

Authentication

X-Schematic-Api-Keystring

API Key authentication via header

Path parameters

company_override_idstringRequired

company_override_id

Request

This endpoint expects an object.

value_typeenumRequired

credit_consumption_ratedouble or nullOptional

expiration_datedatetime or nullOptional

metric_periodenum or nullOptional

Allowed values:

metric_period_month_resetenum or nullOptional

Allowed values:

notestring or nullOptional

value_boolboolean or nullOptional

value_credit_idstring or nullOptional

value_numericinteger or nullOptional

value_trait_idstring or nullOptional

Response

dataobject

paramsobject

Input parameters

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error