List feature usage

GET

https://api.schematichq.com/feature-usage

GET

/feature-usage

1 import { SchematicClient } from "@schematichq/schematic-typescript-node";
2 
3 async function main() {
4     const client = new SchematicClient({
5         apiKey: "YOUR_API_KEY_HERE",
6     });
7     await client.entitlements.listFeatureUsage({});
8 }
9 main();

1 {
2   "data": [
3     {
4       "access": true,
5       "allocation_type": "boolean",
6       "entitlement_id": "string",
7       "entitlement_type": "company_override",
8       "allocation": 1,
9       "company_override": {
10         "company_id": "string",
11         "created_at": "2024-01-15T09:30:00Z",
12         "environment_id": "string",
13         "feature_id": "string",
14         "id": "string",
15         "notes": [
16           {
17             "created_at": "2024-01-15T09:30:00Z",
18             "external_user_id": "string",
19             "external_user_name": "string",
20             "id": "string",
21             "note": "string",
22             "updated_at": "2024-01-15T09:30:00Z"
23           }
24         ],
25         "updated_at": "2024-01-15T09:30:00Z",
26         "value_type": "boolean",
27         "company": {
28           "add_ons": [
29             {
30               "id": "string",
31               "included_credit_grants": [
32                 {
33                   "billing_credit_auto_topup_enabled": true,
34                   "created_at": "2024-01-15T09:30:00Z",
35                   "credit_amount": 1,
36                   "credit_id": "string",
37                   "id": "string",
38                   "plan_id": "string",
39                   "reset_type": "no_reset",
40                   "updated_at": "2024-01-15T09:30:00Z",
41                   "credit_description": "string",
42                   "credit_name": "string",
43                   "billing_credit_auto_topup_amount": 1,
44                   "billing_credit_auto_topup_amount_type": "string",
45                   "billing_credit_auto_topup_expiry_type": "duration",
46                   "billing_credit_auto_topup_expiry_unit": "billing_periods",
47                   "billing_credit_auto_topup_expiry_unit_count": 1,
48                   "billing_credit_auto_topup_threshold_credits": 1,
49                   "billing_credit_auto_topup_threshold_percent": 1,
50                   "credit": {
51                     "account_id": "string",
52                     "burn_strategy": "expiration_priority",
53                     "cost_editable": true,
54                     "created_at": "2024-01-15T09:30:00Z",
55                     "default_expiry_unit": "billing_periods",
56                     "default_rollover_policy": "expire",
57                     "description": "string",
58                     "environment_id": "string",
59                     "id": "string",
60                     "name": "string",
61                     "updated_at": "2024-01-15T09:30:00Z",
62                     "default_expiry_unit_count": 1,
63                     "icon": "string",
64                     "plural_name": "string",
65                     "price": {
66                       "billing_scheme": "per_unit",
67                       "created_at": "2024-01-15T09:30:00Z",
68                       "currency": "string",
69                       "id": "string",
70                       "interval": "day",
71                       "is_active": true,
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                       "product_external_id": "string",
85                       "product_id": "string",
86                       "product_name": "string",
87                       "provider_type": "orb",
88                       "updated_at": "2024-01-15T09:30:00Z",
89                       "usage_type": "licensed",
90                       "meter_event_name": "string",
91                       "meter_event_payload_key": "string",
92                       "meter_id": "string",
93                       "price_decimal": "string",
94                       "tiers_mode": "graduated"
95                     },
96                     "price_per_unit": 1,
97                     "price_per_unit_decimal": "string",
98                     "product": {
99                       "account_id": "string",
100                       "created_at": "2024-01-15T09:30:00Z",
101                       "environment_id": "string",
102                       "external_id": "string",
103                       "is_active": true,
104                       "name": "string",
105                       "price": 1.1,
106                       "product_id": "string",
107                       "provider_type": "orb",
108                       "quantity": 1.1,
109                       "updated_at": "2024-01-15T09:30:00Z",
110                       "price_decimal": "string",
111                       "currency": "string"
112                     },
113                     "singular_name": "string"
114                   },
115                   "expiry_type": "duration",
116                   "expiry_unit": "billing_periods",
117                   "expiry_unit_count": 1,
118                   "plan": {
119                     "id": "string",
120                     "name": "string",
121                     "description": "string",
122                     "image_url": "string"
123                   },
124                   "plan_version_id": "string",
125                   "reset_cadence": "daily",
126                   "reset_start": "billing_period",
127                   "credit_icon": "string",
128                   "plural_name": "string",
129                   "singular_name": "string"
130                 }
131               ],
132               "name": "string",
133               "added_on": "2024-01-15T09:30:00Z",
134               "billing_product_external_id": "string",
135               "billing_product_id": "string",
136               "description": "string",
137               "image_url": "string",
138               "plan_period": "string",
139               "plan_price": 1,
140               "plan_version_id": "string"
141             }
142           ],
143           "billing_subscriptions": [
144             {
145               "cancel_at_period_end": true,
146               "created_at": "2024-01-15T09:30:00Z",
147               "currency": "string",
148               "customer_external_id": "string",
149               "discounts": [
150                 {
151                   "coupon_id": "string",
152                   "coupon_name": "string",
153                   "discount_external_id": "string",
154                   "duration": "string",
155                   "is_active": true,
156                   "started_at": "2024-01-15T09:30:00Z",
157                   "subscription_external_id": "string",
158                   "amount_off": 1,
159                   "currency": "string",
160                   "customer_facing_code": "string",
161                   "duration_in_months": 1,
162                   "ended_at": "2024-01-15T09:30:00Z",
163                   "percent_off": 1.1,
164                   "promo_code_external_id": "string"
165                 }
166               ],
167               "id": "string",
168               "interval": "string",
169               "period_end": 1,
170               "period_start": 1,
171               "products": [
172                 {
173                   "billing_scheme": "per_unit",
174                   "created_at": "2024-01-15T09:30:00Z",
175                   "currency": "string",
176                   "environment_id": "string",
177                   "external_id": "string",
178                   "id": "string",
179                   "interval": "string",
180                   "name": "string",
181                   "package_size": 1,
182                   "price": 1,
183                   "price_external_id": "string",
184                   "price_id": "string",
185                   "price_tier": [
186                     {
187                       "flat_amount": 1,
188                       "per_unit_price": 1,
189                       "per_unit_price_decimal": "string",
190                       "up_to": 1
191                     }
192                   ],
193                   "provider_type": "orb",
194                   "quantity": 1.1,
195                   "subscription_id": "string",
196                   "updated_at": "2024-01-15T09:30:00Z",
197                   "usage_type": "licensed",
198                   "billing_threshold": 1,
199                   "meter_id": "string",
200                   "price_decimal": "string",
201                   "subscription_item_external_id": "string"
202                 }
203               ],
204               "provider_type": "orb",
205               "status": "string",
206               "subscription_external_id": "string",
207               "total_price": 1,
208               "application_id": "string",
209               "cancel_at": 1,
210               "company_id": "string",
211               "default_payment_method_id": "string",
212               "expired_at": "2024-01-15T09:30:00Z",
213               "latest_invoice": {
214                 "amount_due": 1,
215                 "amount_paid": 1,
216                 "amount_remaining": 1,
217                 "collection_method": "string",
218                 "created_at": "2024-01-15T09:30:00Z",
219                 "currency": "string",
220                 "customer_external_id": "string",
221                 "environment_id": "string",
222                 "id": "string",
223                 "provider_type": "orb",
224                 "subtotal": 1,
225                 "updated_at": "2024-01-15T09:30:00Z",
226                 "company_id": "string",
227                 "due_date": "2024-01-15T09:30:00Z",
228                 "external_id": "string",
229                 "payment_method_external_id": "string",
230                 "status": "draft",
231                 "subscription_external_id": "string",
232                 "url": "string"
233               },
234               "metadata": {},
235               "payment_method": {
236                 "created_at": "2024-01-15T09:30:00Z",
237                 "customer_external_id": "string",
238                 "environment_id": "string",
239                 "external_id": "string",
240                 "id": "string",
241                 "payment_method_type": "string",
242                 "provider_type": "orb",
243                 "updated_at": "2024-01-15T09:30:00Z",
244                 "account_last4": "string",
245                 "account_name": "string",
246                 "bank_name": "string",
247                 "billing_email": "string",
248                 "billing_name": "string",
249                 "card_brand": "string",
250                 "card_exp_month": 1,
251                 "card_exp_year": 1,
252                 "card_last4": "string",
253                 "company_id": "string"
254               },
255               "trial_end": 1,
256               "trial_end_setting": "cancel"
257             }
258           ],
259           "created_at": "2024-01-15T09:30:00Z",
260           "entitlements": [
261             {
262               "feature_id": "string",
263               "feature_key": "string",
264               "value_type": "boolean",
265               "allocation": 1,
266               "credit_id": "string",
267               "credit_remaining": 1.1,
268               "credit_total": 1.1,
269               "credit_used": 1.1,
270               "event_name": "string",
271               "metric_period": "all_time",
272               "metric_reset_at": "2024-01-15T09:30:00Z",
273               "month_reset": "first_of_month",
274               "soft_limit": 1,
275               "usage": 1
276             }
277           ],
278           "entity_traits": [
279             {
280               "created_at": "2024-01-15T09:30:00Z",
281               "definition_id": "string",
282               "environment_id": "string",
283               "id": "string",
284               "updated_at": "2024-01-15T09:30:00Z",
285               "value": "string",
286               "definition": {
287                 "created_at": "2024-01-15T09:30:00Z",
288                 "display_name": "string",
289                 "entity_type": "company",
290                 "hierarchy": [
291                   "string"
292                 ],
293                 "id": "string",
294                 "trait_type": "boolean",
295                 "updated_at": "2024-01-15T09:30:00Z"
296               }
297             }
298           ],
299           "environment_id": "string",
300           "id": "string",
301           "keys": [
302             {
303               "created_at": "2024-01-15T09:30:00Z",
304               "definition_id": "string",
305               "entity_id": "string",
306               "entity_type": "company",
307               "environment_id": "string",
308               "id": "string",
309               "key": "string",
310               "updated_at": "2024-01-15T09:30:00Z",
311               "value": "string",
312               "definition": {
313                 "created_at": "2024-01-15T09:30:00Z",
314                 "entity_type": "company",
315                 "id": "string",
316                 "key": "string",
317                 "updated_at": "2024-01-15T09:30:00Z"
318               }
319             }
320           ],
321           "metrics": [
322             {
323               "account_id": "string",
324               "captured_at_max": "2024-01-15T09:30:00Z",
325               "captured_at_min": "2024-01-15T09:30:00Z",
326               "company_id": "string",
327               "created_at": "2024-01-15T09:30:00Z",
328               "environment_id": "string",
329               "event_subtype": "string",
330               "month_reset": "string",
331               "period": "string",
332               "value": 1,
333               "valid_until": "2024-01-15T09:30:00Z"
334             }
335           ],
336           "name": "string",
337           "payment_methods": [
338             {
339               "created_at": "2024-01-15T09:30:00Z",
340               "customer_external_id": "string",
341               "environment_id": "string",
342               "external_id": "string",
343               "id": "string",
344               "payment_method_type": "string",
345               "provider_type": "orb",
346               "updated_at": "2024-01-15T09:30:00Z",
347               "account_last4": "string",
348               "account_name": "string",
349               "bank_name": "string",
350               "billing_email": "string",
351               "billing_name": "string",
352               "card_brand": "string",
353               "card_exp_month": 1,
354               "card_exp_year": 1,
355               "card_last4": "string",
356               "company_id": "string"
357             }
358           ],
359           "plans": [
360             {
361               "id": "string",
362               "name": "string",
363               "description": "string",
364               "image_url": "string"
365             }
366           ],
367           "rules": [
368             {
369               "account_id": "string",
370               "condition_groups": [
371                 {
372                   "conditions": [
373                     {
374                       "account_id": "string",
375                       "condition_type": "base_plan",
376                       "environment_id": "string",
377                       "id": "string",
378                       "operator": "eq",
379                       "resource_ids": [
380                         "string"
381                       ],
382                       "trait_value": "string",
383                       "comparison_trait_definition": {
384                         "comparable_type": "bool",
385                         "entity_type": "company",
386                         "id": "string"
387                       },
388                       "consumption_rate": 1.1,
389                       "credit_id": "string",
390                       "event_subtype": "string",
391                       "metric_period": "all_time",
392                       "metric_period_month_reset": "first_of_month",
393                       "metric_value": 1,
394                       "trait_definition": {
395                         "comparable_type": "bool",
396                         "entity_type": "company",
397                         "id": "string"
398                       }
399                     }
400                   ]
401                 }
402               ],
403               "conditions": [
404                 {
405                   "account_id": "string",
406                   "condition_type": "base_plan",
407                   "environment_id": "string",
408                   "id": "string",
409                   "operator": "eq",
410                   "resource_ids": [
411                     "string"
412                   ],
413                   "trait_value": "string",
414                   "comparison_trait_definition": {
415                     "comparable_type": "bool",
416                     "entity_type": "company",
417                     "id": "string"
418                   },
419                   "consumption_rate": 1.1,
420                   "credit_id": "string",
421                   "event_subtype": "string",
422                   "metric_period": "all_time",
423                   "metric_period_month_reset": "first_of_month",
424                   "metric_value": 1,
425                   "trait_definition": {
426                     "comparable_type": "bool",
427                     "entity_type": "company",
428                     "id": "string"
429                   }
430                 }
431               ],
432               "environment_id": "string",
433               "id": "string",
434               "name": "string",
435               "priority": 1,
436               "rule_type": "default",
437               "value": true,
438               "flag_id": "string"
439             }
440           ],
441           "updated_at": "2024-01-15T09:30:00Z",
442           "user_count": 1,
443           "billing_credit_balances": {},
444           "billing_subscription": {
445             "cancel_at_period_end": true,
446             "created_at": "2024-01-15T09:30:00Z",
447             "currency": "string",
448             "customer_external_id": "string",
449             "discounts": [
450               {
451                 "coupon_id": "string",
452                 "coupon_name": "string",
453                 "discount_external_id": "string",
454                 "duration": "string",
455                 "is_active": true,
456                 "started_at": "2024-01-15T09:30:00Z",
457                 "subscription_external_id": "string",
458                 "amount_off": 1,
459                 "currency": "string",
460                 "customer_facing_code": "string",
461                 "duration_in_months": 1,
462                 "ended_at": "2024-01-15T09:30:00Z",
463                 "percent_off": 1.1,
464                 "promo_code_external_id": "string"
465               }
466             ],
467             "id": "string",
468             "interval": "string",
469             "period_end": 1,
470             "period_start": 1,
471             "products": [
472               {
473                 "billing_scheme": "per_unit",
474                 "created_at": "2024-01-15T09:30:00Z",
475                 "currency": "string",
476                 "environment_id": "string",
477                 "external_id": "string",
478                 "id": "string",
479                 "interval": "string",
480                 "name": "string",
481                 "package_size": 1,
482                 "price": 1,
483                 "price_external_id": "string",
484                 "price_id": "string",
485                 "price_tier": [
486                   {
487                     "flat_amount": 1,
488                     "per_unit_price": 1,
489                     "per_unit_price_decimal": "string",
490                     "up_to": 1
491                   }
492                 ],
493                 "provider_type": "orb",
494                 "quantity": 1.1,
495                 "subscription_id": "string",
496                 "updated_at": "2024-01-15T09:30:00Z",
497                 "usage_type": "licensed",
498                 "billing_threshold": 1,
499                 "meter_id": "string",
500                 "price_decimal": "string",
501                 "subscription_item_external_id": "string"
502               }
503             ],
504             "provider_type": "orb",
505             "status": "string",
506             "subscription_external_id": "string",
507             "total_price": 1,
508             "application_id": "string",
509             "cancel_at": 1,
510             "company_id": "string",
511             "default_payment_method_id": "string",
512             "expired_at": "2024-01-15T09:30:00Z",
513             "latest_invoice": {
514               "amount_due": 1,
515               "amount_paid": 1,
516               "amount_remaining": 1,
517               "collection_method": "string",
518               "created_at": "2024-01-15T09:30:00Z",
519               "currency": "string",
520               "customer_external_id": "string",
521               "environment_id": "string",
522               "id": "string",
523               "provider_type": "orb",
524               "subtotal": 1,
525               "updated_at": "2024-01-15T09:30:00Z",
526               "company_id": "string",
527               "due_date": "2024-01-15T09:30:00Z",
528               "external_id": "string",
529               "payment_method_external_id": "string",
530               "status": "draft",
531               "subscription_external_id": "string",
532               "url": "string"
533             },
534             "metadata": {},
535             "payment_method": {
536               "created_at": "2024-01-15T09:30:00Z",
537               "customer_external_id": "string",
538               "environment_id": "string",
539               "external_id": "string",
540               "id": "string",
541               "payment_method_type": "string",
542               "provider_type": "orb",
543               "updated_at": "2024-01-15T09:30:00Z",
544               "account_last4": "string",
545               "account_name": "string",
546               "bank_name": "string",
547               "billing_email": "string",
548               "billing_name": "string",
549               "card_brand": "string",
550               "card_exp_month": 1,
551               "card_exp_year": 1,
552               "card_last4": "string",
553               "company_id": "string"
554             },
555             "trial_end": 1,
556             "trial_end_setting": "cancel"
557           },
558           "default_payment_method": {
559             "created_at": "2024-01-15T09:30:00Z",
560             "customer_external_id": "string",
561             "environment_id": "string",
562             "external_id": "string",
563             "id": "string",
564             "payment_method_type": "string",
565             "provider_type": "orb",
566             "updated_at": "2024-01-15T09:30:00Z",
567             "account_last4": "string",
568             "account_name": "string",
569             "bank_name": "string",
570             "billing_email": "string",
571             "billing_name": "string",
572             "card_brand": "string",
573             "card_exp_month": 1,
574             "card_exp_year": 1,
575             "card_last4": "string",
576             "company_id": "string"
577           },
578           "last_seen_at": "2024-01-15T09:30:00Z",
579           "logo_url": "string",
580           "plan": {
581             "id": "string",
582             "included_credit_grants": [
583               {
584                 "billing_credit_auto_topup_enabled": true,
585                 "created_at": "2024-01-15T09:30:00Z",
586                 "credit_amount": 1,
587                 "credit_id": "string",
588                 "id": "string",
589                 "plan_id": "string",
590                 "reset_type": "no_reset",
591                 "updated_at": "2024-01-15T09:30:00Z",
592                 "credit_description": "string",
593                 "credit_name": "string",
594                 "billing_credit_auto_topup_amount": 1,
595                 "billing_credit_auto_topup_amount_type": "string",
596                 "billing_credit_auto_topup_expiry_type": "duration",
597                 "billing_credit_auto_topup_expiry_unit": "billing_periods",
598                 "billing_credit_auto_topup_expiry_unit_count": 1,
599                 "billing_credit_auto_topup_threshold_credits": 1,
600                 "billing_credit_auto_topup_threshold_percent": 1,
601                 "credit": {
602                   "account_id": "string",
603                   "burn_strategy": "expiration_priority",
604                   "cost_editable": true,
605                   "created_at": "2024-01-15T09:30:00Z",
606                   "default_expiry_unit": "billing_periods",
607                   "default_rollover_policy": "expire",
608                   "description": "string",
609                   "environment_id": "string",
610                   "id": "string",
611                   "name": "string",
612                   "updated_at": "2024-01-15T09:30:00Z",
613                   "default_expiry_unit_count": 1,
614                   "icon": "string",
615                   "plural_name": "string",
616                   "price": {
617                     "billing_scheme": "per_unit",
618                     "created_at": "2024-01-15T09:30:00Z",
619                     "currency": "string",
620                     "id": "string",
621                     "interval": "day",
622                     "is_active": true,
623                     "package_size": 1,
624                     "price": 1,
625                     "price_external_id": "string",
626                     "price_id": "string",
627                     "price_tier": [
628                       {
629                         "flat_amount": 1,
630                         "per_unit_price": 1,
631                         "per_unit_price_decimal": "string",
632                         "up_to": 1
633                       }
634                     ],
635                     "product_external_id": "string",
636                     "product_id": "string",
637                     "product_name": "string",
638                     "provider_type": "orb",
639                     "updated_at": "2024-01-15T09:30:00Z",
640                     "usage_type": "licensed",
641                     "meter_event_name": "string",
642                     "meter_event_payload_key": "string",
643                     "meter_id": "string",
644                     "price_decimal": "string",
645                     "tiers_mode": "graduated"
646                   },
647                   "price_per_unit": 1,
648                   "price_per_unit_decimal": "string",
649                   "product": {
650                     "account_id": "string",
651                     "created_at": "2024-01-15T09:30:00Z",
652                     "environment_id": "string",
653                     "external_id": "string",
654                     "is_active": true,
655                     "name": "string",
656                     "price": 1.1,
657                     "product_id": "string",
658                     "provider_type": "orb",
659                     "quantity": 1.1,
660                     "updated_at": "2024-01-15T09:30:00Z",
661                     "price_decimal": "string",
662                     "currency": "string"
663                   },
664                   "singular_name": "string"
665                 },
666                 "expiry_type": "duration",
667                 "expiry_unit": "billing_periods",
668                 "expiry_unit_count": 1,
669                 "plan": {
670                   "id": "string",
671                   "name": "string",
672                   "description": "string",
673                   "image_url": "string"
674                 },
675                 "plan_version_id": "string",
676                 "reset_cadence": "daily",
677                 "reset_start": "billing_period",
678                 "credit_icon": "string",
679                 "plural_name": "string",
680                 "singular_name": "string"
681               }
682             ],
683             "name": "string",
684             "added_on": "2024-01-15T09:30:00Z",
685             "billing_product_external_id": "string",
686             "billing_product_id": "string",
687             "description": "string",
688             "image_url": "string",
689             "plan_period": "string",
690             "plan_price": 1,
691             "plan_version_id": "string"
692           },
693           "scheduled_downgrade": {
694             "currency": "string",
695             "effective_after": "2024-01-15T09:30:00Z",
696             "from_plan_id": "string",
697             "from_plan_name": "string",
698             "from_subscription_price": 1,
699             "id": "string",
700             "interval": "string",
701             "to_plan_id": "string",
702             "to_plan_name": "string",
703             "scheduled_interval": "string",
704             "scheduled_price": 1
705           },
706           "traits": {}
707         },
708         "consumption_rate": 1.1,
709         "expiration_date": "2024-01-15T09:30:00Z",
710         "feature": {
711           "created_at": "2024-01-15T09:30:00Z",
712           "description": "string",
713           "feature_type": "boolean",
714           "icon": "string",
715           "id": "string",
716           "name": "string",
717           "updated_at": "2024-01-15T09:30:00Z",
718           "event_subtype": "string",
719           "lifecycle_phase": "add_on",
720           "maintainer_id": "string",
721           "plural_name": "string",
722           "singular_name": "string",
723           "trait_id": "string"
724         },
725         "metric_period": "string",
726         "metric_period_month_reset": "string",
727         "rule_id": "string",
728         "rule_id_usage_exceeded": "string",
729         "value_bool": true,
730         "value_numeric": 1,
731         "value_trait": {
732           "created_at": "2024-01-15T09:30:00Z",
733           "display_name": "string",
734           "entity_type": "company",
735           "hierarchy": [
736             "string"
737           ],
738           "id": "string",
739           "trait_type": "boolean",
740           "updated_at": "2024-01-15T09:30:00Z"
741         },
742         "value_trait_id": "string"
743       },
744       "credit_consumption_rate": 1.1,
745       "credit_grant_counts": {},
746       "credit_grant_details": [
747         {
748           "grant_reason": "adjustment",
749           "quantity": 1.1,
750           "credit_type_icon": "string",
751           "expires_at": "2024-01-15T09:30:00Z"
752         }
753       ],
754       "credit_grant_reason": "adjustment",
755       "credit_remaining": 1.1,
756       "credit_type_icon": "string",
757       "credit_usage_aggregation": {
758         "usage_this_billing_period": 1.1,
759         "usage_this_calendar_month": 1.1,
760         "usage_this_week": 1.1,
761         "usage_today": 1.1
762       },
763       "credit_used": 1.1,
764       "effective_limit": 1,
765       "effective_price": 1.1,
766       "entitlement_expiration_date": "2024-01-15T09:30:00Z",
767       "entitlement_source": "string",
768       "feature": {
769         "created_at": "2024-01-15T09:30:00Z",
770         "description": "string",
771         "feature_type": "boolean",
772         "flags": [
773           {
774             "created_at": "2024-01-15T09:30:00Z",
775             "default_value": true,
776             "description": "string",
777             "flag_type": "boolean",
778             "id": "string",
779             "key": "string",
780             "name": "string",
781             "rules": [
782               {
783                 "condition_groups": [
784                   {
785                     "conditions": [
786                       {
787                         "condition_type": "string",
788                         "created_at": "2024-01-15T09:30:00Z",
789                         "environment_id": "string",
790                         "id": "string",
791                         "operator": "string",
792                         "resource_ids": [
793                           "string"
794                         ],
795                         "resources": [
796                           {
797                             "id": "string",
798                             "name": "string",
799                             "description": "string",
800                             "image_url": "string"
801                           }
802                         ],
803                         "rule_id": "string",
804                         "trait_value": "string",
805                         "updated_at": "2024-01-15T09:30:00Z",
806                         "comparison_trait": {
807                           "created_at": "2024-01-15T09:30:00Z",
808                           "display_name": "string",
809                           "entity_type": "company",
810                           "hierarchy": [
811                             "string"
812                           ],
813                           "id": "string",
814                           "trait_type": "boolean",
815                           "updated_at": "2024-01-15T09:30:00Z"
816                         },
817                         "comparison_trait_id": "string",
818                         "condition_group_id": "string",
819                         "event_subtype": "string",
820                         "flag_id": "string",
821                         "metric_period": "string",
822                         "metric_period_month_reset": "string",
823                         "metric_value": 1,
824                         "trait": {
825                           "created_at": "2024-01-15T09:30:00Z",
826                           "display_name": "string",
827                           "entity_type": "company",
828                           "hierarchy": [
829                             "string"
830                           ],
831                           "id": "string",
832                           "trait_type": "boolean",
833                           "updated_at": "2024-01-15T09:30:00Z"
834                         },
835                         "trait_entity_type": "company",
836                         "trait_id": "string"
837                       }
838                     ],
839                     "created_at": "2024-01-15T09:30:00Z",
840                     "environment_id": "string",
841                     "id": "string",
842                     "rule_id": "string",
843                     "updated_at": "2024-01-15T09:30:00Z",
844                     "flag_id": "string"
845                   }
846                 ],
847                 "conditions": [
848                   {
849                     "condition_type": "string",
850                     "created_at": "2024-01-15T09:30:00Z",
851                     "environment_id": "string",
852                     "id": "string",
853                     "operator": "string",
854                     "resource_ids": [
855                       "string"
856                     ],
857                     "resources": [
858                       {
859                         "id": "string",
860                         "name": "string",
861                         "description": "string",
862                         "image_url": "string"
863                       }
864                     ],
865                     "rule_id": "string",
866                     "trait_value": "string",
867                     "updated_at": "2024-01-15T09:30:00Z",
868                     "comparison_trait": {
869                       "created_at": "2024-01-15T09:30:00Z",
870                       "display_name": "string",
871                       "entity_type": "company",
872                       "hierarchy": [
873                         "string"
874                       ],
875                       "id": "string",
876                       "trait_type": "boolean",
877                       "updated_at": "2024-01-15T09:30:00Z"
878                     },
879                     "comparison_trait_id": "string",
880                     "condition_group_id": "string",
881                     "event_subtype": "string",
882                     "flag_id": "string",
883                     "metric_period": "string",
884                     "metric_period_month_reset": "string",
885                     "metric_value": 1,
886                     "trait": {
887                       "created_at": "2024-01-15T09:30:00Z",
888                       "display_name": "string",
889                       "entity_type": "company",
890                       "hierarchy": [
891                         "string"
892                       ],
893                       "id": "string",
894                       "trait_type": "boolean",
895                       "updated_at": "2024-01-15T09:30:00Z"
896                     },
897                     "trait_entity_type": "company",
898                     "trait_id": "string"
899                   }
900                 ],
901                 "created_at": "2024-01-15T09:30:00Z",
902                 "environment_id": "string",
903                 "id": "string",
904                 "name": "string",
905                 "priority": 1,
906                 "rule_type": "string",
907                 "updated_at": "2024-01-15T09:30:00Z",
908                 "value": true,
909                 "flag_id": "string"
910               }
911             ],
912             "updated_at": "2024-01-15T09:30:00Z",
913             "feature": {
914               "created_at": "2024-01-15T09:30:00Z",
915               "description": "string",
916               "feature_type": "boolean",
917               "icon": "string",
918               "id": "string",
919               "name": "string",
920               "updated_at": "2024-01-15T09:30:00Z",
921               "event_subtype": "string",
922               "lifecycle_phase": "add_on",
923               "maintainer_id": "string",
924               "plural_name": "string",
925               "singular_name": "string",
926               "trait_id": "string"
927             },
928             "feature_id": "string",
929             "last_checked_at": "2024-01-15T09:30:00Z",
930             "maintainer_id": "string"
931           }
932         ],
933         "icon": "string",
934         "id": "string",
935         "name": "string",
936         "plans": [
937           {
938             "id": "string",
939             "name": "string",
940             "description": "string",
941             "image_url": "string"
942           }
943         ],
944         "updated_at": "2024-01-15T09:30:00Z",
945         "billing_linked_resource": {
946           "billing_provider": "orb",
947           "external_resource_id": "string",
948           "originator": "orb"
949         },
950         "event_subtype": "string",
951         "event_summary": {
952           "company_count": 1,
953           "environment_id": "string",
954           "event_count": 1,
955           "event_subtype": "string",
956           "user_count": 1,
957           "last_seen_at": "2024-01-15T09:30:00Z"
958         },
959         "lifecycle_phase": "add_on",
960         "maintainer_id": "string",
961         "plural_name": "string",
962         "singular_name": "string",
963         "trait": {
964           "created_at": "2024-01-15T09:30:00Z",
965           "display_name": "string",
966           "entity_type": "company",
967           "hierarchy": [
968             "string"
969           ],
970           "id": "string",
971           "trait_type": "boolean",
972           "updated_at": "2024-01-15T09:30:00Z"
973         },
974         "trait_id": "string"
975       },
976       "has_valid_allocation": true,
977       "is_unlimited": true,
978       "metric_reset_at": "2024-01-15T09:30:00Z",
979       "month_reset": "string",
980       "monthly_usage_based_price": {
981         "billing_scheme": "per_unit",
982         "created_at": "2024-01-15T09:30:00Z",
983         "currency": "string",
984         "id": "string",
985         "interval": "day",
986         "is_active": true,
987         "package_size": 1,
988         "price": 1,
989         "price_external_id": "string",
990         "price_id": "string",
991         "price_tier": [
992           {
993             "flat_amount": 1,
994             "per_unit_price": 1,
995             "per_unit_price_decimal": "string",
996             "up_to": 1
997           }
998         ],
999         "product_external_id": "string",
1000         "product_id": "string",
1001         "product_name": "string",
1002         "provider_type": "orb",
1003         "updated_at": "2024-01-15T09:30:00Z",
1004         "usage_type": "licensed",
1005         "meter_event_name": "string",
1006         "meter_event_payload_key": "string",
1007         "meter_id": "string",
1008         "price_decimal": "string",
1009         "tiers_mode": "graduated"
1010       },
1011       "overuse": 1,
1012       "percent_used": 1.1,
1013       "period": "string",
1014       "plan": {
1015         "created_at": "2024-01-15T09:30:00Z",
1016         "description": "string",
1017         "icon": "amber",
1018         "id": "string",
1019         "name": "string",
1020         "plan_type": "plan",
1021         "updated_at": "2024-01-15T09:30:00Z",
1022         "audience_type": "string"
1023       },
1024       "plan_entitlement": {
1025         "created_at": "2024-01-15T09:30:00Z",
1026         "currency_prices": [
1027           {
1028             "currency": "string",
1029             "monthly_price": {
1030               "billing_scheme": "per_unit",
1031               "created_at": "2024-01-15T09:30:00Z",
1032               "currency": "string",
1033               "id": "string",
1034               "interval": "day",
1035               "is_active": true,
1036               "package_size": 1,
1037               "price": 1,
1038               "price_external_id": "string",
1039               "price_id": "string",
1040               "price_tier": [
1041                 {
1042                   "flat_amount": 1,
1043                   "per_unit_price": 1,
1044                   "per_unit_price_decimal": "string",
1045                   "up_to": 1
1046                 }
1047               ],
1048               "product_external_id": "string",
1049               "product_id": "string",
1050               "product_name": "string",
1051               "provider_type": "orb",
1052               "updated_at": "2024-01-15T09:30:00Z",
1053               "usage_type": "licensed",
1054               "meter_event_name": "string",
1055               "meter_event_payload_key": "string",
1056               "meter_id": "string",
1057               "price_decimal": "string",
1058               "tiers_mode": "graduated"
1059             },
1060             "yearly_price": {
1061               "billing_scheme": "per_unit",
1062               "created_at": "2024-01-15T09:30:00Z",
1063               "currency": "string",
1064               "id": "string",
1065               "interval": "day",
1066               "is_active": true,
1067               "package_size": 1,
1068               "price": 1,
1069               "price_external_id": "string",
1070               "price_id": "string",
1071               "price_tier": [
1072                 {
1073                   "flat_amount": 1,
1074                   "per_unit_price": 1,
1075                   "per_unit_price_decimal": "string",
1076                   "up_to": 1
1077                 }
1078               ],
1079               "product_external_id": "string",
1080               "product_id": "string",
1081               "product_name": "string",
1082               "provider_type": "orb",
1083               "updated_at": "2024-01-15T09:30:00Z",
1084               "usage_type": "licensed",
1085               "meter_event_name": "string",
1086               "meter_event_payload_key": "string",
1087               "meter_id": "string",
1088               "price_decimal": "string",
1089               "tiers_mode": "graduated"
1090             }
1091           }
1092         ],
1093         "environment_id": "string",
1094         "feature_id": "string",
1095         "id": "string",
1096         "plan_id": "string",
1097         "rule_id": "string",
1098         "updated_at": "2024-01-15T09:30:00Z",
1099         "value_type": "boolean",
1100         "billing_linked_resource": {
1101           "billing_provider": "orb",
1102           "external_resource_id": "string",
1103           "originator": "orb"
1104         },
1105         "billing_threshold": 1,
1106         "consumption_rate": 1.1,
1107         "feature": {
1108           "created_at": "2024-01-15T09:30:00Z",
1109           "description": "string",
1110           "feature_type": "boolean",
1111           "icon": "string",
1112           "id": "string",
1113           "name": "string",
1114           "updated_at": "2024-01-15T09:30:00Z",
1115           "event_subtype": "string",
1116           "lifecycle_phase": "add_on",
1117           "maintainer_id": "string",
1118           "plural_name": "string",
1119           "singular_name": "string",
1120           "trait_id": "string"
1121         },
1122         "metered_monthly_price": {
1123           "billing_scheme": "per_unit",
1124           "created_at": "2024-01-15T09:30:00Z",
1125           "currency": "string",
1126           "id": "string",
1127           "interval": "day",
1128           "is_active": true,
1129           "package_size": 1,
1130           "price": 1,
1131           "price_external_id": "string",
1132           "price_id": "string",
1133           "price_tier": [
1134             {
1135               "flat_amount": 1,
1136               "per_unit_price": 1,
1137               "per_unit_price_decimal": "string",
1138               "up_to": 1
1139             }
1140           ],
1141           "product_external_id": "string",
1142           "product_id": "string",
1143           "product_name": "string",
1144           "provider_type": "orb",
1145           "updated_at": "2024-01-15T09:30:00Z",
1146           "usage_type": "licensed",
1147           "meter_event_name": "string",
1148           "meter_event_payload_key": "string",
1149           "meter_id": "string",
1150           "price_decimal": "string",
1151           "tiers_mode": "graduated"
1152         },
1153         "metered_yearly_price": {
1154           "billing_scheme": "per_unit",
1155           "created_at": "2024-01-15T09:30:00Z",
1156           "currency": "string",
1157           "id": "string",
1158           "interval": "day",
1159           "is_active": true,
1160           "package_size": 1,
1161           "price": 1,
1162           "price_external_id": "string",
1163           "price_id": "string",
1164           "price_tier": [
1165             {
1166               "flat_amount": 1,
1167               "per_unit_price": 1,
1168               "per_unit_price_decimal": "string",
1169               "up_to": 1
1170             }
1171           ],
1172           "product_external_id": "string",
1173           "product_id": "string",
1174           "product_name": "string",
1175           "provider_type": "orb",
1176           "updated_at": "2024-01-15T09:30:00Z",
1177           "usage_type": "licensed",
1178           "meter_event_name": "string",
1179           "meter_event_payload_key": "string",
1180           "meter_id": "string",
1181           "price_decimal": "string",
1182           "tiers_mode": "graduated"
1183         },
1184         "metric_period": "string",
1185         "metric_period_month_reset": "string",
1186         "plan": {
1187           "created_at": "2024-01-15T09:30:00Z",
1188           "description": "string",
1189           "icon": "amber",
1190           "id": "string",
1191           "name": "string",
1192           "plan_type": "plan",
1193           "updated_at": "2024-01-15T09:30:00Z",
1194           "audience_type": "string"
1195         },
1196         "price_behavior": "credit_burndown",
1197         "rule_id_usage_exceeded": "string",
1198         "soft_limit": 1,
1199         "usage_based_product": {
1200           "account_id": "string",
1201           "created_at": "2024-01-15T09:30:00Z",
1202           "environment_id": "string",
1203           "external_id": "string",
1204           "is_active": true,
1205           "name": "string",
1206           "price": 1.1,
1207           "product_id": "string",
1208           "provider_type": "orb",
1209           "quantity": 1.1,
1210           "updated_at": "2024-01-15T09:30:00Z",
1211           "price_decimal": "string",
1212           "currency": "string"
1213         },
1214         "value_bool": true,
1215         "value_credit": {
1216           "burn_strategy": "expiration_priority",
1217           "cost_editable": true,
1218           "created_at": "2024-01-15T09:30:00Z",
1219           "currency_prices": [
1220             {
1221               "currency": "string",
1222               "price": {
1223                 "currency": "string",
1224                 "external_price_id": "string",
1225                 "id": "string",
1226                 "interval": "day",
1227                 "price": 1,
1228                 "provider_type": "orb",
1229                 "scheme": "per_unit",
1230                 "price_decimal": "string"
1231               }
1232             }
1233           ],
1234           "default_expiry_unit": "billing_periods",
1235           "default_rollover_policy": "expire",
1236           "description": "string",
1237           "id": "string",
1238           "name": "string",
1239           "updated_at": "2024-01-15T09:30:00Z",
1240           "default_expiry_unit_count": 1,
1241           "icon": "string",
1242           "plural_name": "string",
1243           "price": {
1244             "currency": "string",
1245             "external_price_id": "string",
1246             "id": "string",
1247             "interval": "day",
1248             "price": 1,
1249             "provider_type": "orb",
1250             "scheme": "per_unit",
1251             "price_decimal": "string"
1252           },
1253           "product": {
1254             "account_id": "string",
1255             "created_at": "2024-01-15T09:30:00Z",
1256             "environment_id": "string",
1257             "external_id": "string",
1258             "is_active": true,
1259             "name": "string",
1260             "price": 1.1,
1261             "product_id": "string",
1262             "provider_type": "orb",
1263             "quantity": 1.1,
1264             "updated_at": "2024-01-15T09:30:00Z",
1265             "price_decimal": "string",
1266             "currency": "string"
1267           },
1268           "singular_name": "string"
1269         },
1270         "value_numeric": 1,
1271         "value_trait": {
1272           "created_at": "2024-01-15T09:30:00Z",
1273           "display_name": "string",
1274           "entity_type": "company",
1275           "hierarchy": [
1276             "string"
1277           ],
1278           "id": "string",
1279           "trait_type": "boolean",
1280           "updated_at": "2024-01-15T09:30:00Z"
1281         },
1282         "value_trait_id": "string"
1283       },
1284       "price_behavior": "credit_burndown",
1285       "soft_limit": 1,
1286       "usage": 1,
1287       "yearly_usage_based_price": {
1288         "billing_scheme": "per_unit",
1289         "created_at": "2024-01-15T09:30:00Z",
1290         "currency": "string",
1291         "id": "string",
1292         "interval": "day",
1293         "is_active": true,
1294         "package_size": 1,
1295         "price": 1,
1296         "price_external_id": "string",
1297         "price_id": "string",
1298         "price_tier": [
1299           {
1300             "flat_amount": 1,
1301             "per_unit_price": 1,
1302             "per_unit_price_decimal": "string",
1303             "up_to": 1
1304           }
1305         ],
1306         "product_external_id": "string",
1307         "product_id": "string",
1308         "product_name": "string",
1309         "provider_type": "orb",
1310         "updated_at": "2024-01-15T09:30:00Z",
1311         "usage_type": "licensed",
1312         "meter_event_name": "string",
1313         "meter_event_payload_key": "string",
1314         "meter_id": "string",
1315         "price_decimal": "string",
1316         "tiers_mode": "graduated"
1317       },
1318       "credit_total": 1.1
1319     }
1320   ],
1321   "params": {
1322     "company_id": "string",
1323     "company_keys": {},
1324     "feature_ids": [
1325       "string"
1326     ],
1327     "include_usage_aggregation": true,
1328     "limit": 100,
1329     "offset": 0,
1330     "q": "string",
1331     "without_negative_entitlements": true
1332   }
1333 }

Authentication

X-Schematic-Api-Keystring

API Key authentication via header

Query parameters

company_idstringOptional

company_keysmap from strings to stringsOptional

feature_idslist of stringsOptional

include_usage_aggregationbooleanOptional

Include time-bucketed usage aggregation (today, this week, this month, billing period) for credit-based entitlements. Defaults to false for performance.

qstringOptional

without_negative_entitlementsbooleanOptional

limitlongOptional

Page limit (default 100)

offsetlongOptional

Page offset (default 0)

Response

datalist of objects

paramsobject

Input parameters

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error