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

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