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": "company_id",
4     "created_at": "2024-01-15T09:30:00Z",
5     "environment_id": "environment_id",
6     "feature_id": "feature_id",
7     "id": "id",
8     "updated_at": "2024-01-15T09:30:00Z",
9     "value_type": "value_type",
10     "company": {
11       "add_ons": [
12         {
13           "id": "id",
14           "name": "name"
15         }
16       ],
17       "billing_subscriptions": [
18         {
19           "cancel_at_period_end": true,
20           "created_at": "2024-01-15T09:30:00Z",
21           "currency": "currency",
22           "customer_external_id": "customer_external_id",
23           "discounts": [
24             {
25               "coupon_id": "coupon_id",
26               "coupon_name": "coupon_name",
27               "discount_external_id": "discount_external_id",
28               "duration": "duration",
29               "is_active": true,
30               "started_at": "2024-01-15T09:30:00Z",
31               "subscription_external_id": "subscription_external_id"
32             }
33           ],
34           "id": "id",
35           "interval": "interval",
36           "period_end": 1,
37           "period_start": 1,
38           "products": [
39             {
40               "billing_scheme": "billing_scheme",
41               "created_at": "2024-01-15T09:30:00Z",
42               "currency": "currency",
43               "environment_id": "environment_id",
44               "external_id": "external_id",
45               "id": "id",
46               "interval": "interval",
47               "name": "name",
48               "package_size": 1,
49               "price": 1,
50               "price_external_id": "price_external_id",
51               "price_id": "price_id",
52               "price_tier": [
53                 {}
54               ],
55               "quantity": 1.1,
56               "subscription_id": "subscription_id",
57               "updated_at": "2024-01-15T09:30:00Z",
58               "usage_type": "usage_type"
59             }
60           ],
61           "status": "status",
62           "subscription_external_id": "subscription_external_id",
63           "total_price": 1
64         }
65       ],
66       "created_at": "2024-01-15T09:30:00Z",
67       "entity_traits": [
68         {
69           "created_at": "2024-01-15T09:30:00Z",
70           "definition_id": "definition_id",
71           "environment_id": "environment_id",
72           "id": "id",
73           "updated_at": "2024-01-15T09:30:00Z",
74           "value": "value"
75         }
76       ],
77       "environment_id": "environment_id",
78       "id": "id",
79       "keys": [
80         {
81           "created_at": "2024-01-15T09:30:00Z",
82           "definition_id": "definition_id",
83           "entity_id": "entity_id",
84           "entity_type": "entity_type",
85           "environment_id": "environment_id",
86           "id": "id",
87           "key": "key",
88           "updated_at": "2024-01-15T09:30:00Z",
89           "value": "value"
90         }
91       ],
92       "metrics": [
93         {
94           "account_id": "account_id",
95           "captured_at_max": "2024-01-15T09:30:00Z",
96           "captured_at_min": "2024-01-15T09:30:00Z",
97           "company_id": "company_id",
98           "created_at": "2024-01-15T09:30:00Z",
99           "environment_id": "environment_id",
100           "event_subtype": "event_subtype",
101           "month_reset": "month_reset",
102           "period": "period",
103           "value": 1
104         }
105       ],
106       "name": "name",
107       "payment_methods": [
108         {
109           "created_at": "2024-01-15T09:30:00Z",
110           "customer_external_id": "customer_external_id",
111           "environment_id": "environment_id",
112           "external_id": "external_id",
113           "id": "id",
114           "payment_method_type": "payment_method_type",
115           "updated_at": "2024-01-15T09:30:00Z"
116         }
117       ],
118       "plans": [
119         {
120           "id": "id",
121           "name": "name"
122         }
123       ],
124       "updated_at": "2024-01-15T09:30:00Z",
125       "user_count": 1,
126       "billing_subscription": {
127         "cancel_at_period_end": true,
128         "created_at": "2024-01-15T09:30:00Z",
129         "currency": "currency",
130         "customer_external_id": "customer_external_id",
131         "discounts": [
132           {
133             "coupon_id": "coupon_id",
134             "coupon_name": "coupon_name",
135             "discount_external_id": "discount_external_id",
136             "duration": "duration",
137             "is_active": true,
138             "started_at": "2024-01-15T09:30:00Z",
139             "subscription_external_id": "subscription_external_id"
140           }
141         ],
142         "id": "id",
143         "interval": "interval",
144         "period_end": 1,
145         "period_start": 1,
146         "products": [
147           {
148             "billing_scheme": "billing_scheme",
149             "created_at": "2024-01-15T09:30:00Z",
150             "currency": "currency",
151             "environment_id": "environment_id",
152             "external_id": "external_id",
153             "id": "id",
154             "interval": "interval",
155             "name": "name",
156             "package_size": 1,
157             "price": 1,
158             "price_external_id": "price_external_id",
159             "price_id": "price_id",
160             "price_tier": [
161               {}
162             ],
163             "quantity": 1.1,
164             "subscription_id": "subscription_id",
165             "updated_at": "2024-01-15T09:30:00Z",
166             "usage_type": "usage_type"
167           }
168         ],
169         "status": "status",
170         "subscription_external_id": "subscription_external_id",
171         "total_price": 1
172       },
173       "default_payment_method": {
174         "created_at": "2024-01-15T09:30:00Z",
175         "customer_external_id": "customer_external_id",
176         "environment_id": "environment_id",
177         "external_id": "external_id",
178         "id": "id",
179         "payment_method_type": "payment_method_type",
180         "updated_at": "2024-01-15T09:30:00Z"
181       },
182       "last_seen_at": "2024-01-15T09:30:00Z",
183       "logo_url": "logo_url",
184       "plan": {
185         "id": "id",
186         "name": "name"
187       },
188       "traits": {
189         "key": "value"
190       }
191     },
192     "expiration_date": "2024-01-15T09:30:00Z",
193     "feature": {
194       "created_at": "2024-01-15T09:30:00Z",
195       "description": "description",
196       "feature_type": "feature_type",
197       "icon": "icon",
198       "id": "id",
199       "name": "name",
200       "updated_at": "2024-01-15T09:30:00Z",
201       "event_subtype": "event_subtype",
202       "lifecycle_phase": "lifecycle_phase",
203       "maintainer_id": "maintainer_id",
204       "plural_name": "plural_name",
205       "singular_name": "singular_name",
206       "trait_id": "trait_id"
207     },
208     "metric_period": "metric_period",
209     "metric_period_month_reset": "metric_period_month_reset",
210     "rule_id": "rule_id",
211     "rule_id_usage_exceeded": "rule_id_usage_exceeded",
212     "value_bool": true,
213     "value_numeric": 1,
214     "value_trait": {
215       "created_at": "2024-01-15T09:30:00Z",
216       "display_name": "display_name",
217       "entity_type": "entity_type",
218       "hierarchy": [
219         "hierarchy"
220       ],
221       "id": "id",
222       "trait_type": "trait_type",
223       "updated_at": "2024-01-15T09:30:00Z"
224     },
225     "value_trait_id": "value_trait_id"
226   },
227   "params": {
228     "key": "value"
229   }
230 }

Request

This endpoint expects an object.

company_idstringRequired

feature_idstringRequired

value_typeenumRequired

Allowed values:

expiration_datedatetimeOptional

metric_periodenumOptional

Allowed values:

metric_period_month_resetenumOptional

Allowed values:

value_boolbooleanOptional

value_numericintegerOptional

value_trait_idstringOptional

Response

Created

dataobject

The updated resource

paramsmap from strings to any

Input parameters

Create company override

Headers

Request

Response

Errors