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

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