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         "effective_limit": 1,
512         "effective_price": 1.1,
513         "entitlement_expiration_date": "2024-01-15T09:30:00Z",
514         "entitlement_source": "string",
515         "feature": {
516           "created_at": "2024-01-15T09:30:00Z",
517           "description": "string",
518           "feature_type": "string",
519           "flags": [
520             {
521               "created_at": "2024-01-15T09:30:00Z",
522               "default_value": true,
523               "description": "string",
524               "flag_type": "string",
525               "id": "string",
526               "key": "string",
527               "name": "string",
528               "rules": [
529                 {
530                   "condition_groups": [
531                     {
532                       "conditions": [
533                         {
534                           "condition_type": "string",
535                           "created_at": "2024-01-15T09:30:00Z",
536                           "environment_id": "string",
537                           "id": "string",
538                           "operator": "string",
539                           "resource_ids": [
540                             "string"
541                           ],
542                           "resources": [
543                             {
544                               "id": "string",
545                               "name": "string",
546                               "description": "string",
547                               "image_url": "string"
548                             }
549                           ],
550                           "rule_id": "string",
551                           "trait_value": "string",
552                           "updated_at": "2024-01-15T09:30:00Z",
553                           "comparison_trait": {
554                             "created_at": "2024-01-15T09:30:00Z",
555                             "display_name": "string",
556                             "entity_type": "string",
557                             "hierarchy": [
558                               "string"
559                             ],
560                             "id": "string",
561                             "trait_type": "string",
562                             "updated_at": "2024-01-15T09:30:00Z"
563                           },
564                           "comparison_trait_id": "string",
565                           "condition_group_id": "string",
566                           "event_subtype": "string",
567                           "flag_id": "string",
568                           "metric_period": "string",
569                           "metric_period_month_reset": "string",
570                           "metric_value": 1,
571                           "trait": {
572                             "created_at": "2024-01-15T09:30:00Z",
573                             "display_name": "string",
574                             "entity_type": "string",
575                             "hierarchy": [
576                               "string"
577                             ],
578                             "id": "string",
579                             "trait_type": "string",
580                             "updated_at": "2024-01-15T09:30:00Z"
581                           },
582                           "trait_entity_type": "string",
583                           "trait_id": "string"
584                         }
585                       ],
586                       "created_at": "2024-01-15T09:30:00Z",
587                       "environment_id": "string",
588                       "id": "string",
589                       "rule_id": "string",
590                       "updated_at": "2024-01-15T09:30:00Z",
591                       "flag_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                       "trait": {
634                         "created_at": "2024-01-15T09:30:00Z",
635                         "display_name": "string",
636                         "entity_type": "string",
637                         "hierarchy": [
638                           "string"
639                         ],
640                         "id": "string",
641                         "trait_type": "string",
642                         "updated_at": "2024-01-15T09:30:00Z"
643                       },
644                       "trait_entity_type": "string",
645                       "trait_id": "string"
646                     }
647                   ],
648                   "created_at": "2024-01-15T09:30:00Z",
649                   "environment_id": "string",
650                   "id": "string",
651                   "name": "string",
652                   "priority": 1,
653                   "rule_type": "string",
654                   "updated_at": "2024-01-15T09:30:00Z",
655                   "value": true,
656                   "flag_id": "string"
657                 }
658               ],
659               "updated_at": "2024-01-15T09:30:00Z",
660               "feature": {
661                 "created_at": "2024-01-15T09:30:00Z",
662                 "description": "string",
663                 "feature_type": "string",
664                 "icon": "string",
665                 "id": "string",
666                 "name": "string",
667                 "updated_at": "2024-01-15T09:30:00Z",
668                 "event_subtype": "string",
669                 "lifecycle_phase": "string",
670                 "maintainer_id": "string",
671                 "plural_name": "string",
672                 "singular_name": "string",
673                 "trait_id": "string"
674               },
675               "feature_id": "string",
676               "last_checked_at": "2024-01-15T09:30:00Z",
677               "maintainer_id": "string"
678             }
679           ],
680           "icon": "string",
681           "id": "string",
682           "name": "string",
683           "plans": [
684             {
685               "id": "string",
686               "name": "string",
687               "description": "string",
688               "image_url": "string"
689             }
690           ],
691           "updated_at": "2024-01-15T09:30:00Z",
692           "event_subtype": "string",
693           "event_summary": {
694             "company_count": 1,
695             "environment_id": "string",
696             "event_count": 1,
697             "event_subtype": "string",
698             "user_count": 1,
699             "last_seen_at": "2024-01-15T09:30:00Z"
700           },
701           "lifecycle_phase": "string",
702           "maintainer_id": "string",
703           "plural_name": "string",
704           "singular_name": "string",
705           "trait": {
706             "created_at": "2024-01-15T09:30:00Z",
707             "display_name": "string",
708             "entity_type": "string",
709             "hierarchy": [
710               "string"
711             ],
712             "id": "string",
713             "trait_type": "string",
714             "updated_at": "2024-01-15T09:30:00Z"
715           },
716           "trait_id": "string"
717         },
718         "has_valid_allocation": true,
719         "is_unlimited": true,
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         "overuse": 1,
753         "percent_used": 1.1,
754         "period": "string",
755         "plan": {
756           "created_at": "2024-01-15T09:30:00Z",
757           "description": "string",
758           "icon": "string",
759           "id": "string",
760           "name": "string",
761           "plan_type": "string",
762           "updated_at": "2024-01-15T09:30:00Z",
763           "audience_type": "string"
764         },
765         "plan_entitlement": {
766           "created_at": "2024-01-15T09:30:00Z",
767           "environment_id": "string",
768           "feature_id": "string",
769           "id": "string",
770           "plan_id": "string",
771           "rule_id": "string",
772           "updated_at": "2024-01-15T09:30:00Z",
773           "value_type": "string",
774           "billing_threshold": 1,
775           "consumption_rate": 1.1,
776           "feature": {
777             "created_at": "2024-01-15T09:30:00Z",
778             "description": "string",
779             "feature_type": "string",
780             "icon": "string",
781             "id": "string",
782             "name": "string",
783             "updated_at": "2024-01-15T09:30:00Z",
784             "event_subtype": "string",
785             "lifecycle_phase": "string",
786             "maintainer_id": "string",
787             "plural_name": "string",
788             "singular_name": "string",
789             "trait_id": "string"
790           },
791           "metered_monthly_price": {
792             "billing_scheme": "string",
793             "created_at": "2024-01-15T09:30:00Z",
794             "currency": "string",
795             "id": "string",
796             "interval": "string",
797             "is_active": true,
798             "package_size": 1,
799             "price": 1,
800             "price_external_id": "string",
801             "price_id": "string",
802             "price_tier": [
803               {
804                 "flat_amount": 1,
805                 "per_unit_price": 1,
806                 "per_unit_price_decimal": "string",
807                 "up_to": 1
808               }
809             ],
810             "product_external_id": "string",
811             "product_id": "string",
812             "product_name": "string",
813             "updated_at": "2024-01-15T09:30:00Z",
814             "usage_type": "string",
815             "meter_event_name": "string",
816             "meter_event_payload_key": "string",
817             "meter_id": "string",
818             "price_decimal": "string",
819             "tiers_mode": "string"
820           },
821           "metered_yearly_price": {
822             "billing_scheme": "string",
823             "created_at": "2024-01-15T09:30:00Z",
824             "currency": "string",
825             "id": "string",
826             "interval": "string",
827             "is_active": true,
828             "package_size": 1,
829             "price": 1,
830             "price_external_id": "string",
831             "price_id": "string",
832             "price_tier": [
833               {
834                 "flat_amount": 1,
835                 "per_unit_price": 1,
836                 "per_unit_price_decimal": "string",
837                 "up_to": 1
838               }
839             ],
840             "product_external_id": "string",
841             "product_id": "string",
842             "product_name": "string",
843             "updated_at": "2024-01-15T09:30:00Z",
844             "usage_type": "string",
845             "meter_event_name": "string",
846             "meter_event_payload_key": "string",
847             "meter_id": "string",
848             "price_decimal": "string",
849             "tiers_mode": "string"
850           },
851           "metric_period": "string",
852           "metric_period_month_reset": "string",
853           "plan": {
854             "created_at": "2024-01-15T09:30:00Z",
855             "description": "string",
856             "icon": "string",
857             "id": "string",
858             "name": "string",
859             "plan_type": "string",
860             "updated_at": "2024-01-15T09:30:00Z",
861             "audience_type": "string"
862           },
863           "price_behavior": "string",
864           "rule_id_usage_exceeded": "string",
865           "soft_limit": 1,
866           "usage_based_product": {
867             "account_id": "string",
868             "created_at": "2024-01-15T09:30:00Z",
869             "environment_id": "string",
870             "external_id": "string",
871             "is_active": true,
872             "name": "string",
873             "price": 1.1,
874             "product_id": "string",
875             "quantity": 1.1,
876             "updated_at": "2024-01-15T09:30:00Z",
877             "price_decimal": "string",
878             "currency": "string"
879           },
880           "value_bool": true,
881           "value_credit": {
882             "burn_strategy": "string",
883             "created_at": "2024-01-15T09:30:00Z",
884             "default_expiry_unit": "string",
885             "default_rollover_policy": "string",
886             "description": "string",
887             "id": "string",
888             "name": "string",
889             "updated_at": "2024-01-15T09:30:00Z",
890             "default_expiry_unit_count": 1,
891             "icon": "string",
892             "plural_name": "string",
893             "price": {
894               "currency": "string",
895               "external_price_id": "string",
896               "id": "string",
897               "interval": "string",
898               "price": 1,
899               "scheme": "string",
900               "price_decimal": "string"
901             },
902             "product": {
903               "account_id": "string",
904               "created_at": "2024-01-15T09:30:00Z",
905               "environment_id": "string",
906               "external_id": "string",
907               "is_active": true,
908               "name": "string",
909               "price": 1.1,
910               "product_id": "string",
911               "quantity": 1.1,
912               "updated_at": "2024-01-15T09:30:00Z",
913               "price_decimal": "string",
914               "currency": "string"
915             },
916             "singular_name": "string"
917           },
918           "value_numeric": 1,
919           "value_trait": {
920             "created_at": "2024-01-15T09:30:00Z",
921             "display_name": "string",
922             "entity_type": "string",
923             "hierarchy": [
924               "string"
925             ],
926             "id": "string",
927             "trait_type": "string",
928             "updated_at": "2024-01-15T09:30:00Z"
929           },
930           "value_trait_id": "string"
931         },
932         "price_behavior": "string",
933         "soft_limit": 1,
934         "usage": 1,
935         "yearly_usage_based_price": {
936           "billing_scheme": "string",
937           "created_at": "2024-01-15T09:30:00Z",
938           "currency": "string",
939           "id": "string",
940           "interval": "string",
941           "is_active": true,
942           "package_size": 1,
943           "price": 1,
944           "price_external_id": "string",
945           "price_id": "string",
946           "price_tier": [
947             {
948               "flat_amount": 1,
949               "per_unit_price": 1,
950               "per_unit_price_decimal": "string",
951               "up_to": 1
952             }
953           ],
954           "product_external_id": "string",
955           "product_id": "string",
956           "product_name": "string",
957           "updated_at": "2024-01-15T09:30:00Z",
958           "usage_type": "string",
959           "meter_event_name": "string",
960           "meter_event_payload_key": "string",
961           "meter_id": "string",
962           "price_decimal": "string",
963           "tiers_mode": "string"
964         }
965       }
966     ]
967   },
968   "params": {
969     "keys": {}
970   }
971 }

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