List company overrides

GET

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

GET

/company-overrides

1 import { SchematicClient } from "@schematichq/schematic-typescript-node";
2 
3 const client = new SchematicClient({ apiKey: "YOUR_API_KEY" });
4 await client.entitlements.listCompanyOverrides();

Try it

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

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

Authentication

Query parameters

Response

Errors