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 const client = new SchematicClient({ apiKey: "YOUR_API_KEY" });
4 await client.entitlements.getFeatureUsageByCompany({
5     keys: {
6         "keys": "keys"
7     }
8 });

Try it

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

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

Authentication

Query parameters

Response

Errors