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();

Try it

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

Authentication

X-Schematic-Api-Keystring

API Key authentication via header

Query parameters

company_idstringOptional

company_keysmap from strings to stringsOptional

feature_idslist of stringsOptional

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