Get feature usage by company

GET

https://api.schematichq.com/usage-by-company

GET

/usage-by-company

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.getFeatureUsageByCompany({
8         keys: {},
9     });
10 }
11 main();

1 {
2   "data": {
3     "features": [
4       {
5         "access": true,
6         "allocation_type": "boolean",
7         "entitlement_id": "string",
8         "entitlement_type": "company_override",
9         "allocation": 1,
10         "company_override": {
11           "company_id": "string",
12           "created_at": "2024-01-15T09:30:00Z",
13           "environment_id": "string",
14           "feature_id": "string",
15           "id": "string",
16           "notes": [
17             {
18               "created_at": "2024-01-15T09:30:00Z",
19               "external_user_id": "string",
20               "external_user_name": "string",
21               "id": "string",
22               "note": "string",
23               "updated_at": "2024-01-15T09:30:00Z"
24             }
25           ],
26           "updated_at": "2024-01-15T09:30:00Z",
27           "value_type": "boolean",
28           "company": {
29             "add_ons": [
30               {
31                 "id": "string",
32                 "included_credit_grants": [
33                   {
34                     "billing_credit_auto_topup_enabled": true,
35                     "created_at": "2024-01-15T09:30:00Z",
36                     "credit_amount": 1,
37                     "credit_id": "string",
38                     "id": "string",
39                     "plan_id": "string",
40                     "reset_type": "no_reset",
41                     "updated_at": "2024-01-15T09:30:00Z",
42                     "credit_description": "string",
43                     "credit_name": "string",
44                     "billing_credit_auto_topup_amount": 1,
45                     "billing_credit_auto_topup_amount_type": "string",
46                     "billing_credit_auto_topup_expiry_type": "duration",
47                     "billing_credit_auto_topup_expiry_unit": "billing_periods",
48                     "billing_credit_auto_topup_expiry_unit_count": 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": "schematic",
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": "schematic",
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": "schematic",
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": "schematic",
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": "schematic",
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": "schematic",
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": "schematic",
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": "schematic",
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": "schematic",
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": "schematic",
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": "schematic",
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": "schematic",
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_percent": 1,
600                   "credit": {
601                     "account_id": "string",
602                     "burn_strategy": "expiration_priority",
603                     "cost_editable": true,
604                     "created_at": "2024-01-15T09:30:00Z",
605                     "default_expiry_unit": "billing_periods",
606                     "default_rollover_policy": "expire",
607                     "description": "string",
608                     "environment_id": "string",
609                     "id": "string",
610                     "name": "string",
611                     "updated_at": "2024-01-15T09:30:00Z",
612                     "default_expiry_unit_count": 1,
613                     "icon": "string",
614                     "plural_name": "string",
615                     "price": {
616                       "billing_scheme": "per_unit",
617                       "created_at": "2024-01-15T09:30:00Z",
618                       "currency": "string",
619                       "id": "string",
620                       "interval": "day",
621                       "is_active": true,
622                       "package_size": 1,
623                       "price": 1,
624                       "price_external_id": "string",
625                       "price_id": "string",
626                       "price_tier": [
627                         {
628                           "flat_amount": 1,
629                           "per_unit_price": 1,
630                           "per_unit_price_decimal": "string",
631                           "up_to": 1
632                         }
633                       ],
634                       "product_external_id": "string",
635                       "product_id": "string",
636                       "product_name": "string",
637                       "provider_type": "schematic",
638                       "updated_at": "2024-01-15T09:30:00Z",
639                       "usage_type": "licensed",
640                       "meter_event_name": "string",
641                       "meter_event_payload_key": "string",
642                       "meter_id": "string",
643                       "price_decimal": "string",
644                       "tiers_mode": "graduated"
645                     },
646                     "price_per_unit": 1,
647                     "price_per_unit_decimal": "string",
648                     "product": {
649                       "account_id": "string",
650                       "created_at": "2024-01-15T09:30:00Z",
651                       "environment_id": "string",
652                       "external_id": "string",
653                       "is_active": true,
654                       "name": "string",
655                       "price": 1.1,
656                       "product_id": "string",
657                       "provider_type": "schematic",
658                       "quantity": 1.1,
659                       "updated_at": "2024-01-15T09:30:00Z",
660                       "price_decimal": "string",
661                       "currency": "string"
662                     },
663                     "singular_name": "string"
664                   },
665                   "expiry_type": "duration",
666                   "expiry_unit": "billing_periods",
667                   "expiry_unit_count": 1,
668                   "plan": {
669                     "id": "string",
670                     "name": "string",
671                     "description": "string",
672                     "image_url": "string"
673                   },
674                   "plan_version_id": "string",
675                   "reset_cadence": "daily",
676                   "reset_start": "billing_period",
677                   "credit_icon": "string",
678                   "plural_name": "string",
679                   "singular_name": "string"
680                 }
681               ],
682               "name": "string",
683               "added_on": "2024-01-15T09:30:00Z",
684               "billing_product_external_id": "string",
685               "billing_product_id": "string",
686               "description": "string",
687               "image_url": "string",
688               "plan_period": "string",
689               "plan_price": 1,
690               "plan_version_id": "string"
691             },
692             "scheduled_downgrade": {
693               "currency": "string",
694               "effective_after": "2024-01-15T09:30:00Z",
695               "from_plan_id": "string",
696               "from_plan_name": "string",
697               "from_subscription_price": 1,
698               "id": "string",
699               "interval": "string",
700               "to_plan_id": "string",
701               "to_plan_name": "string",
702               "scheduled_interval": "string",
703               "scheduled_price": 1
704             },
705             "traits": {}
706           },
707           "consumption_rate": 1.1,
708           "expiration_date": "2024-01-15T09:30:00Z",
709           "feature": {
710             "created_at": "2024-01-15T09:30:00Z",
711             "description": "string",
712             "feature_type": "boolean",
713             "icon": "string",
714             "id": "string",
715             "name": "string",
716             "updated_at": "2024-01-15T09:30:00Z",
717             "event_subtype": "string",
718             "lifecycle_phase": "add_on",
719             "maintainer_id": "string",
720             "plural_name": "string",
721             "singular_name": "string",
722             "trait_id": "string"
723           },
724           "metric_period": "string",
725           "metric_period_month_reset": "string",
726           "rule_id": "string",
727           "rule_id_usage_exceeded": "string",
728           "value_bool": true,
729           "value_numeric": 1,
730           "value_trait": {
731             "created_at": "2024-01-15T09:30:00Z",
732             "display_name": "string",
733             "entity_type": "company",
734             "hierarchy": [
735               "string"
736             ],
737             "id": "string",
738             "trait_type": "boolean",
739             "updated_at": "2024-01-15T09:30:00Z"
740           },
741           "value_trait_id": "string"
742         },
743         "credit_consumption_rate": 1.1,
744         "credit_grant_counts": {},
745         "credit_grant_details": [
746           {
747             "grant_reason": "billing_credit_auto_topup",
748             "quantity": 1.1,
749             "credit_type_icon": "string",
750             "expires_at": "2024-01-15T09:30:00Z"
751           }
752         ],
753         "credit_grant_reason": "billing_credit_auto_topup",
754         "credit_remaining": 1.1,
755         "credit_type_icon": "string",
756         "credit_usage_aggregation": {
757           "usage_this_billing_period": 1.1,
758           "usage_this_calendar_month": 1.1,
759           "usage_this_week": 1.1,
760           "usage_today": 1.1
761         },
762         "credit_used": 1.1,
763         "effective_limit": 1,
764         "effective_price": 1.1,
765         "entitlement_expiration_date": "2024-01-15T09:30:00Z",
766         "entitlement_source": "string",
767         "feature": {
768           "created_at": "2024-01-15T09:30:00Z",
769           "description": "string",
770           "feature_type": "boolean",
771           "flags": [
772             {
773               "created_at": "2024-01-15T09:30:00Z",
774               "default_value": true,
775               "description": "string",
776               "flag_type": "boolean",
777               "id": "string",
778               "key": "string",
779               "name": "string",
780               "rules": [
781                 {
782                   "condition_groups": [
783                     {
784                       "conditions": [
785                         {
786                           "condition_type": "string",
787                           "created_at": "2024-01-15T09:30:00Z",
788                           "environment_id": "string",
789                           "id": "string",
790                           "operator": "string",
791                           "resource_ids": [
792                             "string"
793                           ],
794                           "resources": [
795                             {
796                               "id": "string",
797                               "name": "string",
798                               "description": "string",
799                               "image_url": "string"
800                             }
801                           ],
802                           "rule_id": "string",
803                           "trait_value": "string",
804                           "updated_at": "2024-01-15T09:30:00Z",
805                           "comparison_trait": {
806                             "created_at": "2024-01-15T09:30:00Z",
807                             "display_name": "string",
808                             "entity_type": "company",
809                             "hierarchy": [
810                               "string"
811                             ],
812                             "id": "string",
813                             "trait_type": "boolean",
814                             "updated_at": "2024-01-15T09:30:00Z"
815                           },
816                           "comparison_trait_id": "string",
817                           "condition_group_id": "string",
818                           "event_subtype": "string",
819                           "flag_id": "string",
820                           "metric_period": "string",
821                           "metric_period_month_reset": "string",
822                           "metric_value": 1,
823                           "trait": {
824                             "created_at": "2024-01-15T09:30:00Z",
825                             "display_name": "string",
826                             "entity_type": "company",
827                             "hierarchy": [
828                               "string"
829                             ],
830                             "id": "string",
831                             "trait_type": "boolean",
832                             "updated_at": "2024-01-15T09:30:00Z"
833                           },
834                           "trait_entity_type": "company",
835                           "trait_id": "string"
836                         }
837                       ],
838                       "created_at": "2024-01-15T09:30:00Z",
839                       "environment_id": "string",
840                       "id": "string",
841                       "rule_id": "string",
842                       "updated_at": "2024-01-15T09:30:00Z",
843                       "flag_id": "string"
844                     }
845                   ],
846                   "conditions": [
847                     {
848                       "condition_type": "string",
849                       "created_at": "2024-01-15T09:30:00Z",
850                       "environment_id": "string",
851                       "id": "string",
852                       "operator": "string",
853                       "resource_ids": [
854                         "string"
855                       ],
856                       "resources": [
857                         {
858                           "id": "string",
859                           "name": "string",
860                           "description": "string",
861                           "image_url": "string"
862                         }
863                       ],
864                       "rule_id": "string",
865                       "trait_value": "string",
866                       "updated_at": "2024-01-15T09:30:00Z",
867                       "comparison_trait": {
868                         "created_at": "2024-01-15T09:30:00Z",
869                         "display_name": "string",
870                         "entity_type": "company",
871                         "hierarchy": [
872                           "string"
873                         ],
874                         "id": "string",
875                         "trait_type": "boolean",
876                         "updated_at": "2024-01-15T09:30:00Z"
877                       },
878                       "comparison_trait_id": "string",
879                       "condition_group_id": "string",
880                       "event_subtype": "string",
881                       "flag_id": "string",
882                       "metric_period": "string",
883                       "metric_period_month_reset": "string",
884                       "metric_value": 1,
885                       "trait": {
886                         "created_at": "2024-01-15T09:30:00Z",
887                         "display_name": "string",
888                         "entity_type": "company",
889                         "hierarchy": [
890                           "string"
891                         ],
892                         "id": "string",
893                         "trait_type": "boolean",
894                         "updated_at": "2024-01-15T09:30:00Z"
895                       },
896                       "trait_entity_type": "company",
897                       "trait_id": "string"
898                     }
899                   ],
900                   "created_at": "2024-01-15T09:30:00Z",
901                   "environment_id": "string",
902                   "id": "string",
903                   "name": "string",
904                   "priority": 1,
905                   "rule_type": "string",
906                   "updated_at": "2024-01-15T09:30:00Z",
907                   "value": true,
908                   "flag_id": "string"
909                 }
910               ],
911               "updated_at": "2024-01-15T09:30:00Z",
912               "feature": {
913                 "created_at": "2024-01-15T09:30:00Z",
914                 "description": "string",
915                 "feature_type": "boolean",
916                 "icon": "string",
917                 "id": "string",
918                 "name": "string",
919                 "updated_at": "2024-01-15T09:30:00Z",
920                 "event_subtype": "string",
921                 "lifecycle_phase": "add_on",
922                 "maintainer_id": "string",
923                 "plural_name": "string",
924                 "singular_name": "string",
925                 "trait_id": "string"
926               },
927               "feature_id": "string",
928               "last_checked_at": "2024-01-15T09:30:00Z",
929               "maintainer_id": "string"
930             }
931           ],
932           "icon": "string",
933           "id": "string",
934           "name": "string",
935           "plans": [
936             {
937               "id": "string",
938               "name": "string",
939               "description": "string",
940               "image_url": "string"
941             }
942           ],
943           "updated_at": "2024-01-15T09:30:00Z",
944           "event_subtype": "string",
945           "event_summary": {
946             "company_count": 1,
947             "environment_id": "string",
948             "event_count": 1,
949             "event_subtype": "string",
950             "user_count": 1,
951             "last_seen_at": "2024-01-15T09:30:00Z"
952           },
953           "lifecycle_phase": "add_on",
954           "maintainer_id": "string",
955           "plural_name": "string",
956           "singular_name": "string",
957           "trait": {
958             "created_at": "2024-01-15T09:30:00Z",
959             "display_name": "string",
960             "entity_type": "company",
961             "hierarchy": [
962               "string"
963             ],
964             "id": "string",
965             "trait_type": "boolean",
966             "updated_at": "2024-01-15T09:30:00Z"
967           },
968           "trait_id": "string"
969         },
970         "has_valid_allocation": true,
971         "is_unlimited": true,
972         "metric_reset_at": "2024-01-15T09:30:00Z",
973         "month_reset": "string",
974         "monthly_usage_based_price": {
975           "billing_scheme": "per_unit",
976           "created_at": "2024-01-15T09:30:00Z",
977           "currency": "string",
978           "id": "string",
979           "interval": "day",
980           "is_active": true,
981           "package_size": 1,
982           "price": 1,
983           "price_external_id": "string",
984           "price_id": "string",
985           "price_tier": [
986             {
987               "flat_amount": 1,
988               "per_unit_price": 1,
989               "per_unit_price_decimal": "string",
990               "up_to": 1
991             }
992           ],
993           "product_external_id": "string",
994           "product_id": "string",
995           "product_name": "string",
996           "provider_type": "schematic",
997           "updated_at": "2024-01-15T09:30:00Z",
998           "usage_type": "licensed",
999           "meter_event_name": "string",
1000           "meter_event_payload_key": "string",
1001           "meter_id": "string",
1002           "price_decimal": "string",
1003           "tiers_mode": "graduated"
1004         },
1005         "overuse": 1,
1006         "percent_used": 1.1,
1007         "period": "string",
1008         "plan": {
1009           "created_at": "2024-01-15T09:30:00Z",
1010           "description": "string",
1011           "icon": "string",
1012           "id": "string",
1013           "name": "string",
1014           "plan_type": "plan",
1015           "updated_at": "2024-01-15T09:30:00Z",
1016           "audience_type": "string"
1017         },
1018         "plan_entitlement": {
1019           "created_at": "2024-01-15T09:30:00Z",
1020           "currency_prices": [
1021             {
1022               "currency": "string",
1023               "monthly_price": {
1024                 "billing_scheme": "per_unit",
1025                 "created_at": "2024-01-15T09:30:00Z",
1026                 "currency": "string",
1027                 "id": "string",
1028                 "interval": "day",
1029                 "is_active": true,
1030                 "package_size": 1,
1031                 "price": 1,
1032                 "price_external_id": "string",
1033                 "price_id": "string",
1034                 "price_tier": [
1035                   {
1036                     "flat_amount": 1,
1037                     "per_unit_price": 1,
1038                     "per_unit_price_decimal": "string",
1039                     "up_to": 1
1040                   }
1041                 ],
1042                 "product_external_id": "string",
1043                 "product_id": "string",
1044                 "product_name": "string",
1045                 "provider_type": "schematic",
1046                 "updated_at": "2024-01-15T09:30:00Z",
1047                 "usage_type": "licensed",
1048                 "meter_event_name": "string",
1049                 "meter_event_payload_key": "string",
1050                 "meter_id": "string",
1051                 "price_decimal": "string",
1052                 "tiers_mode": "graduated"
1053               },
1054               "yearly_price": {
1055                 "billing_scheme": "per_unit",
1056                 "created_at": "2024-01-15T09:30:00Z",
1057                 "currency": "string",
1058                 "id": "string",
1059                 "interval": "day",
1060                 "is_active": true,
1061                 "package_size": 1,
1062                 "price": 1,
1063                 "price_external_id": "string",
1064                 "price_id": "string",
1065                 "price_tier": [
1066                   {
1067                     "flat_amount": 1,
1068                     "per_unit_price": 1,
1069                     "per_unit_price_decimal": "string",
1070                     "up_to": 1
1071                   }
1072                 ],
1073                 "product_external_id": "string",
1074                 "product_id": "string",
1075                 "product_name": "string",
1076                 "provider_type": "schematic",
1077                 "updated_at": "2024-01-15T09:30:00Z",
1078                 "usage_type": "licensed",
1079                 "meter_event_name": "string",
1080                 "meter_event_payload_key": "string",
1081                 "meter_id": "string",
1082                 "price_decimal": "string",
1083                 "tiers_mode": "graduated"
1084               }
1085             }
1086           ],
1087           "environment_id": "string",
1088           "feature_id": "string",
1089           "id": "string",
1090           "plan_id": "string",
1091           "rule_id": "string",
1092           "updated_at": "2024-01-15T09:30:00Z",
1093           "value_type": "boolean",
1094           "billing_threshold": 1,
1095           "consumption_rate": 1.1,
1096           "feature": {
1097             "created_at": "2024-01-15T09:30:00Z",
1098             "description": "string",
1099             "feature_type": "boolean",
1100             "icon": "string",
1101             "id": "string",
1102             "name": "string",
1103             "updated_at": "2024-01-15T09:30:00Z",
1104             "event_subtype": "string",
1105             "lifecycle_phase": "add_on",
1106             "maintainer_id": "string",
1107             "plural_name": "string",
1108             "singular_name": "string",
1109             "trait_id": "string"
1110           },
1111           "metered_monthly_price": {
1112             "billing_scheme": "per_unit",
1113             "created_at": "2024-01-15T09:30:00Z",
1114             "currency": "string",
1115             "id": "string",
1116             "interval": "day",
1117             "is_active": true,
1118             "package_size": 1,
1119             "price": 1,
1120             "price_external_id": "string",
1121             "price_id": "string",
1122             "price_tier": [
1123               {
1124                 "flat_amount": 1,
1125                 "per_unit_price": 1,
1126                 "per_unit_price_decimal": "string",
1127                 "up_to": 1
1128               }
1129             ],
1130             "product_external_id": "string",
1131             "product_id": "string",
1132             "product_name": "string",
1133             "provider_type": "schematic",
1134             "updated_at": "2024-01-15T09:30:00Z",
1135             "usage_type": "licensed",
1136             "meter_event_name": "string",
1137             "meter_event_payload_key": "string",
1138             "meter_id": "string",
1139             "price_decimal": "string",
1140             "tiers_mode": "graduated"
1141           },
1142           "metered_yearly_price": {
1143             "billing_scheme": "per_unit",
1144             "created_at": "2024-01-15T09:30:00Z",
1145             "currency": "string",
1146             "id": "string",
1147             "interval": "day",
1148             "is_active": true,
1149             "package_size": 1,
1150             "price": 1,
1151             "price_external_id": "string",
1152             "price_id": "string",
1153             "price_tier": [
1154               {
1155                 "flat_amount": 1,
1156                 "per_unit_price": 1,
1157                 "per_unit_price_decimal": "string",
1158                 "up_to": 1
1159               }
1160             ],
1161             "product_external_id": "string",
1162             "product_id": "string",
1163             "product_name": "string",
1164             "provider_type": "schematic",
1165             "updated_at": "2024-01-15T09:30:00Z",
1166             "usage_type": "licensed",
1167             "meter_event_name": "string",
1168             "meter_event_payload_key": "string",
1169             "meter_id": "string",
1170             "price_decimal": "string",
1171             "tiers_mode": "graduated"
1172           },
1173           "metric_period": "string",
1174           "metric_period_month_reset": "string",
1175           "plan": {
1176             "created_at": "2024-01-15T09:30:00Z",
1177             "description": "string",
1178             "icon": "string",
1179             "id": "string",
1180             "name": "string",
1181             "plan_type": "plan",
1182             "updated_at": "2024-01-15T09:30:00Z",
1183             "audience_type": "string"
1184           },
1185           "price_behavior": "credit_burndown",
1186           "rule_id_usage_exceeded": "string",
1187           "soft_limit": 1,
1188           "usage_based_product": {
1189             "account_id": "string",
1190             "created_at": "2024-01-15T09:30:00Z",
1191             "environment_id": "string",
1192             "external_id": "string",
1193             "is_active": true,
1194             "name": "string",
1195             "price": 1.1,
1196             "product_id": "string",
1197             "provider_type": "schematic",
1198             "quantity": 1.1,
1199             "updated_at": "2024-01-15T09:30:00Z",
1200             "price_decimal": "string",
1201             "currency": "string"
1202           },
1203           "value_bool": true,
1204           "value_credit": {
1205             "burn_strategy": "expiration_priority",
1206             "cost_editable": true,
1207             "created_at": "2024-01-15T09:30:00Z",
1208             "currency_prices": [
1209               {
1210                 "currency": "string",
1211                 "price": {
1212                   "currency": "string",
1213                   "external_price_id": "string",
1214                   "id": "string",
1215                   "interval": "day",
1216                   "price": 1,
1217                   "provider_type": "schematic",
1218                   "scheme": "per_unit",
1219                   "price_decimal": "string"
1220                 }
1221               }
1222             ],
1223             "default_expiry_unit": "billing_periods",
1224             "default_rollover_policy": "expire",
1225             "description": "string",
1226             "id": "string",
1227             "name": "string",
1228             "updated_at": "2024-01-15T09:30:00Z",
1229             "default_expiry_unit_count": 1,
1230             "icon": "string",
1231             "plural_name": "string",
1232             "price": {
1233               "currency": "string",
1234               "external_price_id": "string",
1235               "id": "string",
1236               "interval": "day",
1237               "price": 1,
1238               "provider_type": "schematic",
1239               "scheme": "per_unit",
1240               "price_decimal": "string"
1241             },
1242             "product": {
1243               "account_id": "string",
1244               "created_at": "2024-01-15T09:30:00Z",
1245               "environment_id": "string",
1246               "external_id": "string",
1247               "is_active": true,
1248               "name": "string",
1249               "price": 1.1,
1250               "product_id": "string",
1251               "provider_type": "schematic",
1252               "quantity": 1.1,
1253               "updated_at": "2024-01-15T09:30:00Z",
1254               "price_decimal": "string",
1255               "currency": "string"
1256             },
1257             "singular_name": "string"
1258           },
1259           "value_numeric": 1,
1260           "value_trait": {
1261             "created_at": "2024-01-15T09:30:00Z",
1262             "display_name": "string",
1263             "entity_type": "company",
1264             "hierarchy": [
1265               "string"
1266             ],
1267             "id": "string",
1268             "trait_type": "boolean",
1269             "updated_at": "2024-01-15T09:30:00Z"
1270           },
1271           "value_trait_id": "string"
1272         },
1273         "price_behavior": "credit_burndown",
1274         "soft_limit": 1,
1275         "usage": 1,
1276         "yearly_usage_based_price": {
1277           "billing_scheme": "per_unit",
1278           "created_at": "2024-01-15T09:30:00Z",
1279           "currency": "string",
1280           "id": "string",
1281           "interval": "day",
1282           "is_active": true,
1283           "package_size": 1,
1284           "price": 1,
1285           "price_external_id": "string",
1286           "price_id": "string",
1287           "price_tier": [
1288             {
1289               "flat_amount": 1,
1290               "per_unit_price": 1,
1291               "per_unit_price_decimal": "string",
1292               "up_to": 1
1293             }
1294           ],
1295           "product_external_id": "string",
1296           "product_id": "string",
1297           "product_name": "string",
1298           "provider_type": "schematic",
1299           "updated_at": "2024-01-15T09:30:00Z",
1300           "usage_type": "licensed",
1301           "meter_event_name": "string",
1302           "meter_event_payload_key": "string",
1303           "meter_id": "string",
1304           "price_decimal": "string",
1305           "tiers_mode": "graduated"
1306         },
1307         "credit_total": 1.1
1308       }
1309     ]
1310   },
1311   "params": {
1312     "keys": {}
1313   }
1314 }

Authentication

X-Schematic-Api-Keystring

API Key authentication via header

Query parameters

keysmap from strings to stringsRequired

Key/value pairs

Response

dataobject

paramsobject

Input parameters

Errors

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error