Create company override

POST

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

POST

/company-overrides

1 import { SchematicClient } from "@schematichq/schematic-typescript-node";
2 
3 const client = new SchematicClient({ apiKey: "YOUR_API_KEY" });
4 await client.entitlements.createCompanyOverride({
5     companyId: "company_id",
6     featureId: "feature_id",
7     valueType: "boolean"
8 });

Try it

1 {
2   "data": {
3     "company_id": "foo",
4     "created_at": "foo",
5     "environment_id": "foo",
6     "feature_id": "foo",
7     "id": "foo",
8     "updated_at": "foo",
9     "value_type": "foo",
10     "company": {
11       "add_ons": [
12         {
13           "id": "foo",
14           "name": "foo",
15           "added_on": "foo",
16           "billing_product_external_id": "foo",
17           "billing_product_id": "foo",
18           "description": "foo",
19           "image_url": "foo",
20           "plan_period": "foo",
21           "plan_price": 42
22         }
23       ],
24       "billing_subscriptions": [
25         {
26           "cancel_at_period_end": true,
27           "created_at": "foo",
28           "currency": "foo",
29           "customer_external_id": "foo",
30           "discounts": [
31             {
32               "coupon_id": "foo",
33               "coupon_name": "foo",
34               "discount_external_id": "foo",
35               "duration": "foo",
36               "is_active": true,
37               "started_at": "foo",
38               "subscription_external_id": "foo",
39               "amount_off": 42,
40               "currency": "foo",
41               "customer_facing_code": "foo",
42               "duration_in_months": 42,
43               "ended_at": "foo",
44               "percent_off": 42,
45               "promo_code_external_id": "foo"
46             }
47           ],
48           "id": "foo",
49           "interval": "foo",
50           "period_end": 42,
51           "period_start": 42,
52           "products": [
53             {
54               "billing_scheme": "foo",
55               "created_at": "foo",
56               "currency": "foo",
57               "environment_id": "foo",
58               "external_id": "foo",
59               "id": "foo",
60               "interval": "foo",
61               "name": "foo",
62               "package_size": 42,
63               "price": 42,
64               "price_external_id": "foo",
65               "price_id": "foo",
66               "price_tier": [
67                 {
68                   "flat_amount": 42,
69                   "per_unit_price": 42,
70                   "per_unit_price_decimal": "foo",
71                   "up_to": 42
72                 }
73               ],
74               "quantity": 42,
75               "subscription_id": "foo",
76               "updated_at": "foo",
77               "usage_type": "foo",
78               "meter_id": "foo",
79               "price_decimal": "foo"
80             }
81           ],
82           "status": "foo",
83           "subscription_external_id": "foo",
84           "total_price": 42,
85           "cancel_at": 42,
86           "company_id": "foo",
87           "default_payment_method_id": "foo",
88           "expired_at": "foo",
89           "latest_invoice": {
90             "amount_due": 42,
91             "amount_paid": 42,
92             "amount_remaining": 42,
93             "collection_method": "foo",
94             "created_at": "foo",
95             "currency": "foo",
96             "customer_external_id": "foo",
97             "environment_id": "foo",
98             "id": "foo",
99             "subtotal": 42,
100             "updated_at": "foo",
101             "company_id": "foo",
102             "due_date": "foo",
103             "external_id": "foo",
104             "payment_method_external_id": "foo",
105             "subscription_external_id": "foo",
106             "url": "foo"
107           },
108           "metadata": {},
109           "payment_method": {
110             "created_at": "foo",
111             "customer_external_id": "foo",
112             "environment_id": "foo",
113             "external_id": "foo",
114             "id": "foo",
115             "payment_method_type": "foo",
116             "updated_at": "foo",
117             "account_last4": "foo",
118             "account_name": "foo",
119             "bank_name": "foo",
120             "billing_email": "foo",
121             "billing_name": "foo",
122             "card_brand": "foo",
123             "card_exp_month": 42,
124             "card_exp_year": 42,
125             "card_last4": "foo",
126             "company_id": "foo"
127           },
128           "trial_end": 42,
129           "trial_end_setting": "foo"
130         }
131       ],
132       "created_at": "foo",
133       "entity_traits": [
134         {
135           "created_at": "foo",
136           "definition_id": "foo",
137           "environment_id": "foo",
138           "id": "foo",
139           "updated_at": "foo",
140           "value": "foo",
141           "definition": {
142             "created_at": "foo",
143             "display_name": "foo",
144             "entity_type": "foo",
145             "hierarchy": [
146               "foo"
147             ],
148             "id": "foo",
149             "trait_type": "foo",
150             "updated_at": "foo"
151           }
152         }
153       ],
154       "environment_id": "foo",
155       "id": "foo",
156       "keys": [
157         {
158           "created_at": "foo",
159           "definition_id": "foo",
160           "entity_id": "foo",
161           "entity_type": "foo",
162           "environment_id": "foo",
163           "id": "foo",
164           "key": "foo",
165           "updated_at": "foo",
166           "value": "foo",
167           "definition": {
168             "created_at": "foo",
169             "entity_type": "foo",
170             "id": "foo",
171             "key": "foo",
172             "updated_at": "foo"
173           }
174         }
175       ],
176       "metrics": [
177         {
178           "account_id": "foo",
179           "captured_at_max": "foo",
180           "captured_at_min": "foo",
181           "company_id": "foo",
182           "created_at": "foo",
183           "environment_id": "foo",
184           "event_subtype": "foo",
185           "month_reset": "foo",
186           "period": "foo",
187           "value": 42,
188           "valid_until": "foo"
189         }
190       ],
191       "name": "foo",
192       "payment_methods": [
193         {
194           "created_at": "foo",
195           "customer_external_id": "foo",
196           "environment_id": "foo",
197           "external_id": "foo",
198           "id": "foo",
199           "payment_method_type": "foo",
200           "updated_at": "foo",
201           "account_last4": "foo",
202           "account_name": "foo",
203           "bank_name": "foo",
204           "billing_email": "foo",
205           "billing_name": "foo",
206           "card_brand": "foo",
207           "card_exp_month": 42,
208           "card_exp_year": 42,
209           "card_last4": "foo",
210           "company_id": "foo"
211         }
212       ],
213       "plans": [
214         {
215           "id": "foo",
216           "name": "foo",
217           "description": "foo",
218           "image_url": "foo"
219         }
220       ],
221       "updated_at": "foo",
222       "user_count": 42,
223       "billing_subscription": {
224         "cancel_at_period_end": true,
225         "created_at": "foo",
226         "currency": "foo",
227         "customer_external_id": "foo",
228         "discounts": [
229           {
230             "coupon_id": "foo",
231             "coupon_name": "foo",
232             "discount_external_id": "foo",
233             "duration": "foo",
234             "is_active": true,
235             "started_at": "foo",
236             "subscription_external_id": "foo",
237             "amount_off": 42,
238             "currency": "foo",
239             "customer_facing_code": "foo",
240             "duration_in_months": 42,
241             "ended_at": "foo",
242             "percent_off": 42,
243             "promo_code_external_id": "foo"
244           }
245         ],
246         "id": "foo",
247         "interval": "foo",
248         "period_end": 42,
249         "period_start": 42,
250         "products": [
251           {
252             "billing_scheme": "foo",
253             "created_at": "foo",
254             "currency": "foo",
255             "environment_id": "foo",
256             "external_id": "foo",
257             "id": "foo",
258             "interval": "foo",
259             "name": "foo",
260             "package_size": 42,
261             "price": 42,
262             "price_external_id": "foo",
263             "price_id": "foo",
264             "price_tier": [
265               {
266                 "flat_amount": 42,
267                 "per_unit_price": 42,
268                 "per_unit_price_decimal": "foo",
269                 "up_to": 42
270               }
271             ],
272             "quantity": 42,
273             "subscription_id": "foo",
274             "updated_at": "foo",
275             "usage_type": "foo",
276             "meter_id": "foo",
277             "price_decimal": "foo"
278           }
279         ],
280         "status": "foo",
281         "subscription_external_id": "foo",
282         "total_price": 42,
283         "cancel_at": 42,
284         "company_id": "foo",
285         "default_payment_method_id": "foo",
286         "expired_at": "foo",
287         "latest_invoice": {
288           "amount_due": 42,
289           "amount_paid": 42,
290           "amount_remaining": 42,
291           "collection_method": "foo",
292           "created_at": "foo",
293           "currency": "foo",
294           "customer_external_id": "foo",
295           "environment_id": "foo",
296           "id": "foo",
297           "subtotal": 42,
298           "updated_at": "foo",
299           "company_id": "foo",
300           "due_date": "foo",
301           "external_id": "foo",
302           "payment_method_external_id": "foo",
303           "subscription_external_id": "foo",
304           "url": "foo"
305         },
306         "metadata": {},
307         "payment_method": {
308           "created_at": "foo",
309           "customer_external_id": "foo",
310           "environment_id": "foo",
311           "external_id": "foo",
312           "id": "foo",
313           "payment_method_type": "foo",
314           "updated_at": "foo",
315           "account_last4": "foo",
316           "account_name": "foo",
317           "bank_name": "foo",
318           "billing_email": "foo",
319           "billing_name": "foo",
320           "card_brand": "foo",
321           "card_exp_month": 42,
322           "card_exp_year": 42,
323           "card_last4": "foo",
324           "company_id": "foo"
325         },
326         "trial_end": 42,
327         "trial_end_setting": "foo"
328       },
329       "default_payment_method": {
330         "created_at": "foo",
331         "customer_external_id": "foo",
332         "environment_id": "foo",
333         "external_id": "foo",
334         "id": "foo",
335         "payment_method_type": "foo",
336         "updated_at": "foo",
337         "account_last4": "foo",
338         "account_name": "foo",
339         "bank_name": "foo",
340         "billing_email": "foo",
341         "billing_name": "foo",
342         "card_brand": "foo",
343         "card_exp_month": 42,
344         "card_exp_year": 42,
345         "card_last4": "foo",
346         "company_id": "foo"
347       },
348       "last_seen_at": "foo",
349       "logo_url": "foo",
350       "plan": {
351         "id": "foo",
352         "name": "foo",
353         "added_on": "foo",
354         "billing_product_external_id": "foo",
355         "billing_product_id": "foo",
356         "description": "foo",
357         "image_url": "foo",
358         "plan_period": "foo",
359         "plan_price": 42
360       },
361       "traits": {}
362     },
363     "consumption_rate": 42,
364     "expiration_date": "foo",
365     "feature": {
366       "created_at": "foo",
367       "description": "foo",
368       "feature_type": "foo",
369       "icon": "foo",
370       "id": "foo",
371       "name": "foo",
372       "updated_at": "foo",
373       "event_subtype": "foo",
374       "lifecycle_phase": "foo",
375       "maintainer_id": "foo",
376       "plural_name": "foo",
377       "singular_name": "foo",
378       "trait_id": "foo"
379     },
380     "metric_period": "foo",
381     "metric_period_month_reset": "foo",
382     "rule_id": "foo",
383     "rule_id_usage_exceeded": "foo",
384     "value_bool": true,
385     "value_numeric": 42,
386     "value_trait": {
387       "created_at": "foo",
388       "display_name": "foo",
389       "entity_type": "foo",
390       "hierarchy": [
391         "foo"
392       ],
393       "id": "foo",
394       "trait_type": "foo",
395       "updated_at": "foo"
396     },
397     "value_trait_id": "foo"
398   },
399   "params": {}
400 }

Request

This endpoint expects an object.

company_idstringRequired

feature_idstringRequired

value_typeenumRequired

Allowed values:

expiration_datestring or nullOptionalformat: "date-time"

metric_periodenum or nullOptional

Allowed values:

metric_period_month_resetenum or nullOptional

Allowed values:

value_boolboolean or nullOptional

value_credit_idstring or nullOptional

value_numericinteger or nullOptional

value_trait_idstring or nullOptional

Response

Created

dataobject

The updated resource

paramsobject

Input parameters

Create company override

Headers

Request

Response

Errors