List feature usage

GET

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

GET

/feature-usage

1 import { SchematicClient } from "@schematichq/schematic-typescript-node";
2 
3 const client = new SchematicClient({ apiKey: "YOUR_API_KEY" });
4 await client.entitlements.listFeatureUsage({
5     companyId: "company_id",
6     includeUsageAggregation: true,
7     q: "q",
8     withoutNegativeEntitlements: true,
9     limit: 1,
10     offset: 1
11 });

Try it

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_description": "string",
37                   "credit_id": "string",
38                   "credit_name": "string",
39                   "id": "string",
40                   "plan_id": "string",
41                   "plan_name": "string",
42                   "reset_cadence": "daily",
43                   "reset_start": "billing_period",
44                   "reset_type": "no_reset",
45                   "updated_at": "2024-01-15T09:30:00Z",
46                   "billing_credit_auto_topup_amount": 1,
47                   "billing_credit_auto_topup_amount_type": "string",
48                   "billing_credit_auto_topup_expiry_type": "duration",
49                   "billing_credit_auto_topup_expiry_unit": "billing_periods",
50                   "billing_credit_auto_topup_expiry_unit_count": 1,
51                   "billing_credit_auto_topup_threshold_percent": 1,
52                   "credit_icon": "string",
53                   "expiry_type": "duration",
54                   "expiry_unit": "billing_periods",
55                   "expiry_unit_count": 1,
56                   "plural_name": "string",
57                   "singular_name": "string"
58                 }
59               ],
60               "name": "string",
61               "added_on": "2024-01-15T09:30:00Z",
62               "billing_product_external_id": "string",
63               "billing_product_id": "string",
64               "description": "string",
65               "image_url": "string",
66               "plan_period": "string",
67               "plan_price": 1
68             }
69           ],
70           "billing_subscriptions": [
71             {
72               "cancel_at_period_end": true,
73               "created_at": "2024-01-15T09:30:00Z",
74               "currency": "string",
75               "customer_external_id": "string",
76               "discounts": [
77                 {
78                   "coupon_id": "string",
79                   "coupon_name": "string",
80                   "discount_external_id": "string",
81                   "duration": "string",
82                   "is_active": true,
83                   "started_at": "2024-01-15T09:30:00Z",
84                   "subscription_external_id": "string",
85                   "amount_off": 1,
86                   "currency": "string",
87                   "customer_facing_code": "string",
88                   "duration_in_months": 1,
89                   "ended_at": "2024-01-15T09:30:00Z",
90                   "percent_off": 1.1,
91                   "promo_code_external_id": "string"
92                 }
93               ],
94               "id": "string",
95               "interval": "string",
96               "period_end": 1,
97               "period_start": 1,
98               "products": [
99                 {
100                   "billing_scheme": "per_unit",
101                   "created_at": "2024-01-15T09:30:00Z",
102                   "currency": "string",
103                   "environment_id": "string",
104                   "external_id": "string",
105                   "id": "string",
106                   "interval": "string",
107                   "name": "string",
108                   "package_size": 1,
109                   "price": 1,
110                   "price_external_id": "string",
111                   "price_id": "string",
112                   "price_tier": [
113                     {
114                       "flat_amount": 1,
115                       "per_unit_price": 1,
116                       "per_unit_price_decimal": "string",
117                       "up_to": 1
118                     }
119                   ],
120                   "provider_type": "schematic",
121                   "quantity": 1.1,
122                   "subscription_id": "string",
123                   "updated_at": "2024-01-15T09:30:00Z",
124                   "usage_type": "licensed",
125                   "billing_threshold": 1,
126                   "meter_id": "string",
127                   "price_decimal": "string",
128                   "subscription_item_external_id": "string"
129                 }
130               ],
131               "provider_type": "schematic",
132               "status": "string",
133               "subscription_external_id": "string",
134               "total_price": 1,
135               "application_id": "string",
136               "cancel_at": 1,
137               "company_id": "string",
138               "default_payment_method_id": "string",
139               "expired_at": "2024-01-15T09:30:00Z",
140               "latest_invoice": {
141                 "amount_due": 1,
142                 "amount_paid": 1,
143                 "amount_remaining": 1,
144                 "collection_method": "string",
145                 "created_at": "2024-01-15T09:30:00Z",
146                 "currency": "string",
147                 "customer_external_id": "string",
148                 "environment_id": "string",
149                 "id": "string",
150                 "provider_type": "schematic",
151                 "subtotal": 1,
152                 "updated_at": "2024-01-15T09:30:00Z",
153                 "company_id": "string",
154                 "due_date": "2024-01-15T09:30:00Z",
155                 "external_id": "string",
156                 "payment_method_external_id": "string",
157                 "subscription_external_id": "string",
158                 "url": "string"
159               },
160               "metadata": {},
161               "payment_method": {
162                 "created_at": "2024-01-15T09:30:00Z",
163                 "customer_external_id": "string",
164                 "environment_id": "string",
165                 "external_id": "string",
166                 "id": "string",
167                 "payment_method_type": "string",
168                 "provider_type": "schematic",
169                 "updated_at": "2024-01-15T09:30:00Z",
170                 "account_last4": "string",
171                 "account_name": "string",
172                 "bank_name": "string",
173                 "billing_email": "string",
174                 "billing_name": "string",
175                 "card_brand": "string",
176                 "card_exp_month": 1,
177                 "card_exp_year": 1,
178                 "card_last4": "string",
179                 "company_id": "string"
180               },
181               "trial_end": 1,
182               "trial_end_setting": "cancel"
183             }
184           ],
185           "created_at": "2024-01-15T09:30:00Z",
186           "entity_traits": [
187             {
188               "created_at": "2024-01-15T09:30:00Z",
189               "definition_id": "string",
190               "environment_id": "string",
191               "id": "string",
192               "updated_at": "2024-01-15T09:30:00Z",
193               "value": "string",
194               "definition": {
195                 "created_at": "2024-01-15T09:30:00Z",
196                 "display_name": "string",
197                 "entity_type": "company",
198                 "hierarchy": [
199                   "string"
200                 ],
201                 "id": "string",
202                 "trait_type": "boolean",
203                 "updated_at": "2024-01-15T09:30:00Z"
204               }
205             }
206           ],
207           "environment_id": "string",
208           "id": "string",
209           "keys": [
210             {
211               "created_at": "2024-01-15T09:30:00Z",
212               "definition_id": "string",
213               "entity_id": "string",
214               "entity_type": "company",
215               "environment_id": "string",
216               "id": "string",
217               "key": "string",
218               "updated_at": "2024-01-15T09:30:00Z",
219               "value": "string",
220               "definition": {
221                 "created_at": "2024-01-15T09:30:00Z",
222                 "entity_type": "company",
223                 "id": "string",
224                 "key": "string",
225                 "updated_at": "2024-01-15T09:30:00Z"
226               }
227             }
228           ],
229           "metrics": [
230             {
231               "account_id": "string",
232               "captured_at_max": "2024-01-15T09:30:00Z",
233               "captured_at_min": "2024-01-15T09:30:00Z",
234               "company_id": "string",
235               "created_at": "2024-01-15T09:30:00Z",
236               "environment_id": "string",
237               "event_subtype": "string",
238               "month_reset": "string",
239               "period": "string",
240               "value": 1,
241               "valid_until": "2024-01-15T09:30:00Z"
242             }
243           ],
244           "name": "string",
245           "payment_methods": [
246             {
247               "created_at": "2024-01-15T09:30:00Z",
248               "customer_external_id": "string",
249               "environment_id": "string",
250               "external_id": "string",
251               "id": "string",
252               "payment_method_type": "string",
253               "provider_type": "schematic",
254               "updated_at": "2024-01-15T09:30:00Z",
255               "account_last4": "string",
256               "account_name": "string",
257               "bank_name": "string",
258               "billing_email": "string",
259               "billing_name": "string",
260               "card_brand": "string",
261               "card_exp_month": 1,
262               "card_exp_year": 1,
263               "card_last4": "string",
264               "company_id": "string"
265             }
266           ],
267           "plans": [
268             {
269               "id": "string",
270               "name": "string",
271               "description": "string",
272               "image_url": "string"
273             }
274           ],
275           "rules": [
276             {
277               "account_id": "string",
278               "condition_groups": [
279                 {
280                   "conditions": [
281                     {
282                       "account_id": "string",
283                       "condition_type": "base_plan",
284                       "environment_id": "string",
285                       "id": "string",
286                       "operator": "eq",
287                       "resource_ids": [
288                         "string"
289                       ],
290                       "trait_value": "string",
291                       "comparison_trait_definition": {
292                         "comparable_type": "bool",
293                         "entity_type": "company",
294                         "id": "string"
295                       },
296                       "consumption_rate": 1.1,
297                       "credit_id": "string",
298                       "event_subtype": "string",
299                       "metric_period": "all_time",
300                       "metric_period_month_reset": "first_of_month",
301                       "metric_value": 1,
302                       "trait_definition": {
303                         "comparable_type": "bool",
304                         "entity_type": "company",
305                         "id": "string"
306                       }
307                     }
308                   ]
309                 }
310               ],
311               "conditions": [
312                 {
313                   "account_id": "string",
314                   "condition_type": "base_plan",
315                   "environment_id": "string",
316                   "id": "string",
317                   "operator": "eq",
318                   "resource_ids": [
319                     "string"
320                   ],
321                   "trait_value": "string",
322                   "comparison_trait_definition": {
323                     "comparable_type": "bool",
324                     "entity_type": "company",
325                     "id": "string"
326                   },
327                   "consumption_rate": 1.1,
328                   "credit_id": "string",
329                   "event_subtype": "string",
330                   "metric_period": "all_time",
331                   "metric_period_month_reset": "first_of_month",
332                   "metric_value": 1,
333                   "trait_definition": {
334                     "comparable_type": "bool",
335                     "entity_type": "company",
336                     "id": "string"
337                   }
338                 }
339               ],
340               "environment_id": "string",
341               "id": "string",
342               "name": "string",
343               "priority": 1,
344               "rule_type": "default",
345               "value": true,
346               "flag_id": "string"
347             }
348           ],
349           "updated_at": "2024-01-15T09:30:00Z",
350           "user_count": 1,
351           "billing_credit_balances": {},
352           "billing_subscription": {
353             "cancel_at_period_end": true,
354             "created_at": "2024-01-15T09:30:00Z",
355             "currency": "string",
356             "customer_external_id": "string",
357             "discounts": [
358               {
359                 "coupon_id": "string",
360                 "coupon_name": "string",
361                 "discount_external_id": "string",
362                 "duration": "string",
363                 "is_active": true,
364                 "started_at": "2024-01-15T09:30:00Z",
365                 "subscription_external_id": "string",
366                 "amount_off": 1,
367                 "currency": "string",
368                 "customer_facing_code": "string",
369                 "duration_in_months": 1,
370                 "ended_at": "2024-01-15T09:30:00Z",
371                 "percent_off": 1.1,
372                 "promo_code_external_id": "string"
373               }
374             ],
375             "id": "string",
376             "interval": "string",
377             "period_end": 1,
378             "period_start": 1,
379             "products": [
380               {
381                 "billing_scheme": "per_unit",
382                 "created_at": "2024-01-15T09:30:00Z",
383                 "currency": "string",
384                 "environment_id": "string",
385                 "external_id": "string",
386                 "id": "string",
387                 "interval": "string",
388                 "name": "string",
389                 "package_size": 1,
390                 "price": 1,
391                 "price_external_id": "string",
392                 "price_id": "string",
393                 "price_tier": [
394                   {
395                     "flat_amount": 1,
396                     "per_unit_price": 1,
397                     "per_unit_price_decimal": "string",
398                     "up_to": 1
399                   }
400                 ],
401                 "provider_type": "schematic",
402                 "quantity": 1.1,
403                 "subscription_id": "string",
404                 "updated_at": "2024-01-15T09:30:00Z",
405                 "usage_type": "licensed",
406                 "billing_threshold": 1,
407                 "meter_id": "string",
408                 "price_decimal": "string",
409                 "subscription_item_external_id": "string"
410               }
411             ],
412             "provider_type": "schematic",
413             "status": "string",
414             "subscription_external_id": "string",
415             "total_price": 1,
416             "application_id": "string",
417             "cancel_at": 1,
418             "company_id": "string",
419             "default_payment_method_id": "string",
420             "expired_at": "2024-01-15T09:30:00Z",
421             "latest_invoice": {
422               "amount_due": 1,
423               "amount_paid": 1,
424               "amount_remaining": 1,
425               "collection_method": "string",
426               "created_at": "2024-01-15T09:30:00Z",
427               "currency": "string",
428               "customer_external_id": "string",
429               "environment_id": "string",
430               "id": "string",
431               "provider_type": "schematic",
432               "subtotal": 1,
433               "updated_at": "2024-01-15T09:30:00Z",
434               "company_id": "string",
435               "due_date": "2024-01-15T09:30:00Z",
436               "external_id": "string",
437               "payment_method_external_id": "string",
438               "subscription_external_id": "string",
439               "url": "string"
440             },
441             "metadata": {},
442             "payment_method": {
443               "created_at": "2024-01-15T09:30:00Z",
444               "customer_external_id": "string",
445               "environment_id": "string",
446               "external_id": "string",
447               "id": "string",
448               "payment_method_type": "string",
449               "provider_type": "schematic",
450               "updated_at": "2024-01-15T09:30:00Z",
451               "account_last4": "string",
452               "account_name": "string",
453               "bank_name": "string",
454               "billing_email": "string",
455               "billing_name": "string",
456               "card_brand": "string",
457               "card_exp_month": 1,
458               "card_exp_year": 1,
459               "card_last4": "string",
460               "company_id": "string"
461             },
462             "trial_end": 1,
463             "trial_end_setting": "cancel"
464           },
465           "default_payment_method": {
466             "created_at": "2024-01-15T09:30:00Z",
467             "customer_external_id": "string",
468             "environment_id": "string",
469             "external_id": "string",
470             "id": "string",
471             "payment_method_type": "string",
472             "provider_type": "schematic",
473             "updated_at": "2024-01-15T09:30:00Z",
474             "account_last4": "string",
475             "account_name": "string",
476             "bank_name": "string",
477             "billing_email": "string",
478             "billing_name": "string",
479             "card_brand": "string",
480             "card_exp_month": 1,
481             "card_exp_year": 1,
482             "card_last4": "string",
483             "company_id": "string"
484           },
485           "last_seen_at": "2024-01-15T09:30:00Z",
486           "logo_url": "string",
487           "plan": {
488             "id": "string",
489             "included_credit_grants": [
490               {
491                 "billing_credit_auto_topup_enabled": true,
492                 "created_at": "2024-01-15T09:30:00Z",
493                 "credit_amount": 1,
494                 "credit_description": "string",
495                 "credit_id": "string",
496                 "credit_name": "string",
497                 "id": "string",
498                 "plan_id": "string",
499                 "plan_name": "string",
500                 "reset_cadence": "daily",
501                 "reset_start": "billing_period",
502                 "reset_type": "no_reset",
503                 "updated_at": "2024-01-15T09:30:00Z",
504                 "billing_credit_auto_topup_amount": 1,
505                 "billing_credit_auto_topup_amount_type": "string",
506                 "billing_credit_auto_topup_expiry_type": "duration",
507                 "billing_credit_auto_topup_expiry_unit": "billing_periods",
508                 "billing_credit_auto_topup_expiry_unit_count": 1,
509                 "billing_credit_auto_topup_threshold_percent": 1,
510                 "credit_icon": "string",
511                 "expiry_type": "duration",
512                 "expiry_unit": "billing_periods",
513                 "expiry_unit_count": 1,
514                 "plural_name": "string",
515                 "singular_name": "string"
516               }
517             ],
518             "name": "string",
519             "added_on": "2024-01-15T09:30:00Z",
520             "billing_product_external_id": "string",
521             "billing_product_id": "string",
522             "description": "string",
523             "image_url": "string",
524             "plan_period": "string",
525             "plan_price": 1
526           },
527           "traits": {}
528         },
529         "consumption_rate": 1.1,
530         "expiration_date": "2024-01-15T09:30:00Z",
531         "feature": {
532           "created_at": "2024-01-15T09:30:00Z",
533           "description": "string",
534           "feature_type": "boolean",
535           "icon": "string",
536           "id": "string",
537           "name": "string",
538           "updated_at": "2024-01-15T09:30:00Z",
539           "event_subtype": "string",
540           "lifecycle_phase": "add_on",
541           "maintainer_id": "string",
542           "plural_name": "string",
543           "singular_name": "string",
544           "trait_id": "string"
545         },
546         "metric_period": "string",
547         "metric_period_month_reset": "string",
548         "rule_id": "string",
549         "rule_id_usage_exceeded": "string",
550         "value_bool": true,
551         "value_numeric": 1,
552         "value_trait": {
553           "created_at": "2024-01-15T09:30:00Z",
554           "display_name": "string",
555           "entity_type": "company",
556           "hierarchy": [
557             "string"
558           ],
559           "id": "string",
560           "trait_type": "boolean",
561           "updated_at": "2024-01-15T09:30:00Z"
562         },
563         "value_trait_id": "string"
564       },
565       "credit_consumption_rate": 1.1,
566       "credit_grant_counts": {},
567       "credit_grant_details": [
568         {
569           "grant_reason": "billing_credit_auto_topup",
570           "quantity": 1.1,
571           "credit_type_icon": "string",
572           "expires_at": "2024-01-15T09:30:00Z"
573         }
574       ],
575       "credit_grant_reason": "billing_credit_auto_topup",
576       "credit_remaining": 1.1,
577       "credit_type_icon": "string",
578       "credit_usage_aggregation": {
579         "usage_this_billing_period": 1.1,
580         "usage_this_calendar_month": 1.1,
581         "usage_this_week": 1.1,
582         "usage_today": 1.1
583       },
584       "credit_used": 1.1,
585       "effective_limit": 1,
586       "effective_price": 1.1,
587       "entitlement_expiration_date": "2024-01-15T09:30:00Z",
588       "entitlement_source": "string",
589       "feature": {
590         "created_at": "2024-01-15T09:30:00Z",
591         "description": "string",
592         "feature_type": "boolean",
593         "flags": [
594           {
595             "created_at": "2024-01-15T09:30:00Z",
596             "default_value": true,
597             "description": "string",
598             "flag_type": "boolean",
599             "id": "string",
600             "key": "string",
601             "name": "string",
602             "rules": [
603               {
604                 "condition_groups": [
605                   {
606                     "conditions": [
607                       {
608                         "condition_type": "string",
609                         "created_at": "2024-01-15T09:30:00Z",
610                         "environment_id": "string",
611                         "id": "string",
612                         "operator": "string",
613                         "resource_ids": [
614                           "string"
615                         ],
616                         "resources": [
617                           {
618                             "id": "string",
619                             "name": "string",
620                             "description": "string",
621                             "image_url": "string"
622                           }
623                         ],
624                         "rule_id": "string",
625                         "trait_value": "string",
626                         "updated_at": "2024-01-15T09:30:00Z",
627                         "comparison_trait": {
628                           "created_at": "2024-01-15T09:30:00Z",
629                           "display_name": "string",
630                           "entity_type": "company",
631                           "hierarchy": [
632                             "string"
633                           ],
634                           "id": "string",
635                           "trait_type": "boolean",
636                           "updated_at": "2024-01-15T09:30:00Z"
637                         },
638                         "comparison_trait_id": "string",
639                         "condition_group_id": "string",
640                         "event_subtype": "string",
641                         "flag_id": "string",
642                         "metric_period": "string",
643                         "metric_period_month_reset": "string",
644                         "metric_value": 1,
645                         "trait": {
646                           "created_at": "2024-01-15T09:30:00Z",
647                           "display_name": "string",
648                           "entity_type": "company",
649                           "hierarchy": [
650                             "string"
651                           ],
652                           "id": "string",
653                           "trait_type": "boolean",
654                           "updated_at": "2024-01-15T09:30:00Z"
655                         },
656                         "trait_entity_type": "company",
657                         "trait_id": "string"
658                       }
659                     ],
660                     "created_at": "2024-01-15T09:30:00Z",
661                     "environment_id": "string",
662                     "id": "string",
663                     "rule_id": "string",
664                     "updated_at": "2024-01-15T09:30:00Z",
665                     "flag_id": "string"
666                   }
667                 ],
668                 "conditions": [
669                   {
670                     "condition_type": "string",
671                     "created_at": "2024-01-15T09:30:00Z",
672                     "environment_id": "string",
673                     "id": "string",
674                     "operator": "string",
675                     "resource_ids": [
676                       "string"
677                     ],
678                     "resources": [
679                       {
680                         "id": "string",
681                         "name": "string",
682                         "description": "string",
683                         "image_url": "string"
684                       }
685                     ],
686                     "rule_id": "string",
687                     "trait_value": "string",
688                     "updated_at": "2024-01-15T09:30:00Z",
689                     "comparison_trait": {
690                       "created_at": "2024-01-15T09:30:00Z",
691                       "display_name": "string",
692                       "entity_type": "company",
693                       "hierarchy": [
694                         "string"
695                       ],
696                       "id": "string",
697                       "trait_type": "boolean",
698                       "updated_at": "2024-01-15T09:30:00Z"
699                     },
700                     "comparison_trait_id": "string",
701                     "condition_group_id": "string",
702                     "event_subtype": "string",
703                     "flag_id": "string",
704                     "metric_period": "string",
705                     "metric_period_month_reset": "string",
706                     "metric_value": 1,
707                     "trait": {
708                       "created_at": "2024-01-15T09:30:00Z",
709                       "display_name": "string",
710                       "entity_type": "company",
711                       "hierarchy": [
712                         "string"
713                       ],
714                       "id": "string",
715                       "trait_type": "boolean",
716                       "updated_at": "2024-01-15T09:30:00Z"
717                     },
718                     "trait_entity_type": "company",
719                     "trait_id": "string"
720                   }
721                 ],
722                 "created_at": "2024-01-15T09:30:00Z",
723                 "environment_id": "string",
724                 "id": "string",
725                 "name": "string",
726                 "priority": 1,
727                 "rule_type": "string",
728                 "updated_at": "2024-01-15T09:30:00Z",
729                 "value": true,
730                 "flag_id": "string"
731               }
732             ],
733             "updated_at": "2024-01-15T09:30:00Z",
734             "feature": {
735               "created_at": "2024-01-15T09:30:00Z",
736               "description": "string",
737               "feature_type": "boolean",
738               "icon": "string",
739               "id": "string",
740               "name": "string",
741               "updated_at": "2024-01-15T09:30:00Z",
742               "event_subtype": "string",
743               "lifecycle_phase": "add_on",
744               "maintainer_id": "string",
745               "plural_name": "string",
746               "singular_name": "string",
747               "trait_id": "string"
748             },
749             "feature_id": "string",
750             "last_checked_at": "2024-01-15T09:30:00Z",
751             "maintainer_id": "string"
752           }
753         ],
754         "icon": "string",
755         "id": "string",
756         "name": "string",
757         "plans": [
758           {
759             "id": "string",
760             "name": "string",
761             "description": "string",
762             "image_url": "string"
763           }
764         ],
765         "updated_at": "2024-01-15T09:30:00Z",
766         "event_subtype": "string",
767         "event_summary": {
768           "company_count": 1,
769           "environment_id": "string",
770           "event_count": 1,
771           "event_subtype": "string",
772           "user_count": 1,
773           "last_seen_at": "2024-01-15T09:30:00Z"
774         },
775         "lifecycle_phase": "add_on",
776         "maintainer_id": "string",
777         "plural_name": "string",
778         "singular_name": "string",
779         "trait": {
780           "created_at": "2024-01-15T09:30:00Z",
781           "display_name": "string",
782           "entity_type": "company",
783           "hierarchy": [
784             "string"
785           ],
786           "id": "string",
787           "trait_type": "boolean",
788           "updated_at": "2024-01-15T09:30:00Z"
789         },
790         "trait_id": "string"
791       },
792       "has_valid_allocation": true,
793       "is_unlimited": true,
794       "metric_reset_at": "2024-01-15T09:30:00Z",
795       "month_reset": "string",
796       "monthly_usage_based_price": {
797         "billing_scheme": "per_unit",
798         "created_at": "2024-01-15T09:30:00Z",
799         "currency": "string",
800         "id": "string",
801         "interval": "day",
802         "is_active": true,
803         "package_size": 1,
804         "price": 1,
805         "price_external_id": "string",
806         "price_id": "string",
807         "price_tier": [
808           {
809             "flat_amount": 1,
810             "per_unit_price": 1,
811             "per_unit_price_decimal": "string",
812             "up_to": 1
813           }
814         ],
815         "product_external_id": "string",
816         "product_id": "string",
817         "product_name": "string",
818         "provider_type": "schematic",
819         "updated_at": "2024-01-15T09:30:00Z",
820         "usage_type": "licensed",
821         "meter_event_name": "string",
822         "meter_event_payload_key": "string",
823         "meter_id": "string",
824         "price_decimal": "string",
825         "tiers_mode": "graduated"
826       },
827       "overuse": 1,
828       "percent_used": 1.1,
829       "period": "string",
830       "plan": {
831         "created_at": "2024-01-15T09:30:00Z",
832         "description": "string",
833         "icon": "string",
834         "id": "string",
835         "name": "string",
836         "plan_type": "plan",
837         "updated_at": "2024-01-15T09:30:00Z",
838         "audience_type": "string"
839       },
840       "plan_entitlement": {
841         "created_at": "2024-01-15T09:30:00Z",
842         "environment_id": "string",
843         "feature_id": "string",
844         "id": "string",
845         "plan_id": "string",
846         "rule_id": "string",
847         "updated_at": "2024-01-15T09:30:00Z",
848         "value_type": "boolean",
849         "billing_threshold": 1,
850         "consumption_rate": 1.1,
851         "feature": {
852           "created_at": "2024-01-15T09:30:00Z",
853           "description": "string",
854           "feature_type": "boolean",
855           "icon": "string",
856           "id": "string",
857           "name": "string",
858           "updated_at": "2024-01-15T09:30:00Z",
859           "event_subtype": "string",
860           "lifecycle_phase": "add_on",
861           "maintainer_id": "string",
862           "plural_name": "string",
863           "singular_name": "string",
864           "trait_id": "string"
865         },
866         "metered_monthly_price": {
867           "billing_scheme": "per_unit",
868           "created_at": "2024-01-15T09:30:00Z",
869           "currency": "string",
870           "id": "string",
871           "interval": "day",
872           "is_active": true,
873           "package_size": 1,
874           "price": 1,
875           "price_external_id": "string",
876           "price_id": "string",
877           "price_tier": [
878             {
879               "flat_amount": 1,
880               "per_unit_price": 1,
881               "per_unit_price_decimal": "string",
882               "up_to": 1
883             }
884           ],
885           "product_external_id": "string",
886           "product_id": "string",
887           "product_name": "string",
888           "provider_type": "schematic",
889           "updated_at": "2024-01-15T09:30:00Z",
890           "usage_type": "licensed",
891           "meter_event_name": "string",
892           "meter_event_payload_key": "string",
893           "meter_id": "string",
894           "price_decimal": "string",
895           "tiers_mode": "graduated"
896         },
897         "metered_yearly_price": {
898           "billing_scheme": "per_unit",
899           "created_at": "2024-01-15T09:30:00Z",
900           "currency": "string",
901           "id": "string",
902           "interval": "day",
903           "is_active": true,
904           "package_size": 1,
905           "price": 1,
906           "price_external_id": "string",
907           "price_id": "string",
908           "price_tier": [
909             {
910               "flat_amount": 1,
911               "per_unit_price": 1,
912               "per_unit_price_decimal": "string",
913               "up_to": 1
914             }
915           ],
916           "product_external_id": "string",
917           "product_id": "string",
918           "product_name": "string",
919           "provider_type": "schematic",
920           "updated_at": "2024-01-15T09:30:00Z",
921           "usage_type": "licensed",
922           "meter_event_name": "string",
923           "meter_event_payload_key": "string",
924           "meter_id": "string",
925           "price_decimal": "string",
926           "tiers_mode": "graduated"
927         },
928         "metric_period": "string",
929         "metric_period_month_reset": "string",
930         "plan": {
931           "created_at": "2024-01-15T09:30:00Z",
932           "description": "string",
933           "icon": "string",
934           "id": "string",
935           "name": "string",
936           "plan_type": "plan",
937           "updated_at": "2024-01-15T09:30:00Z",
938           "audience_type": "string"
939         },
940         "price_behavior": "credit_burndown",
941         "rule_id_usage_exceeded": "string",
942         "soft_limit": 1,
943         "usage_based_product": {
944           "account_id": "string",
945           "created_at": "2024-01-15T09:30:00Z",
946           "environment_id": "string",
947           "external_id": "string",
948           "is_active": true,
949           "name": "string",
950           "price": 1.1,
951           "product_id": "string",
952           "provider_type": "schematic",
953           "quantity": 1.1,
954           "updated_at": "2024-01-15T09:30:00Z",
955           "price_decimal": "string",
956           "currency": "string"
957         },
958         "value_bool": true,
959         "value_credit": {
960           "burn_strategy": "expiration_priority",
961           "created_at": "2024-01-15T09:30:00Z",
962           "default_expiry_unit": "billing_periods",
963           "default_rollover_policy": "expire",
964           "description": "string",
965           "id": "string",
966           "name": "string",
967           "updated_at": "2024-01-15T09:30:00Z",
968           "default_expiry_unit_count": 1,
969           "icon": "string",
970           "plural_name": "string",
971           "price": {
972             "currency": "string",
973             "external_price_id": "string",
974             "id": "string",
975             "interval": "day",
976             "price": 1,
977             "provider_type": "schematic",
978             "scheme": "per_unit",
979             "price_decimal": "string"
980           },
981           "product": {
982             "account_id": "string",
983             "created_at": "2024-01-15T09:30:00Z",
984             "environment_id": "string",
985             "external_id": "string",
986             "is_active": true,
987             "name": "string",
988             "price": 1.1,
989             "product_id": "string",
990             "provider_type": "schematic",
991             "quantity": 1.1,
992             "updated_at": "2024-01-15T09:30:00Z",
993             "price_decimal": "string",
994             "currency": "string"
995           },
996           "singular_name": "string"
997         },
998         "value_numeric": 1,
999         "value_trait": {
1000           "created_at": "2024-01-15T09:30:00Z",
1001           "display_name": "string",
1002           "entity_type": "company",
1003           "hierarchy": [
1004             "string"
1005           ],
1006           "id": "string",
1007           "trait_type": "boolean",
1008           "updated_at": "2024-01-15T09:30:00Z"
1009         },
1010         "value_trait_id": "string"
1011       },
1012       "price_behavior": "credit_burndown",
1013       "soft_limit": 1,
1014       "usage": 1,
1015       "yearly_usage_based_price": {
1016         "billing_scheme": "per_unit",
1017         "created_at": "2024-01-15T09:30:00Z",
1018         "currency": "string",
1019         "id": "string",
1020         "interval": "day",
1021         "is_active": true,
1022         "package_size": 1,
1023         "price": 1,
1024         "price_external_id": "string",
1025         "price_id": "string",
1026         "price_tier": [
1027           {
1028             "flat_amount": 1,
1029             "per_unit_price": 1,
1030             "per_unit_price_decimal": "string",
1031             "up_to": 1
1032           }
1033         ],
1034         "product_external_id": "string",
1035         "product_id": "string",
1036         "product_name": "string",
1037         "provider_type": "schematic",
1038         "updated_at": "2024-01-15T09:30:00Z",
1039         "usage_type": "licensed",
1040         "meter_event_name": "string",
1041         "meter_event_payload_key": "string",
1042         "meter_id": "string",
1043         "price_decimal": "string",
1044         "tiers_mode": "graduated"
1045       },
1046       "credit_total": 1.1
1047     }
1048   ],
1049   "params": {
1050     "company_id": "string",
1051     "company_keys": {},
1052     "feature_ids": [
1053       "string"
1054     ],
1055     "include_usage_aggregation": true,
1056     "limit": 100,
1057     "offset": 0,
1058     "q": "string",
1059     "without_negative_entitlements": true
1060   }
1061 }

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

limitintegerOptional

Page limit (default 100)

offsetintegerOptional

Page offset (default 0)

Response

datalist of objects

paramsobject

Input parameters

Authentication

Query parameters

Response

Errors