For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
SupportDashboard
Getting StartedAPI ReferenceRoadmapBlog
Getting StartedAPI ReferenceRoadmapBlog
    • Resources
    • Authentication
    • Pagination
    • Rate limiting
  • API Keys
    • GETList api keys
    • GETGet api key
    • POSTCreate api key
    • PUTUpdate api key
    • DELDelete api key
  • Environments
    • POSTCreate environment
    • PUTUpdate environment
    • DELDelete environment
  • Plans
    • The Plan object
    • GETList plans
    • GETGet plan
    • POSTCreate plan
    • PUTUpdate plan
    • DELDelete plan
  • Companies
    • The Company object
    • GETList companies
    • POSTUpsert company
    • GETLookup company
    • DELDelete company
    • POSTDelete company by keys
    • GETList company memberships
    • POSTGet or create company membership
    • DELDelete company membership
    • POSTUpsert company trait
  • Users
    • The User object
    • GETList users
    • GETLookup user
    • POSTUpsert user
    • DELDelete user
    • POSTDelete user by keys
    • POSTUpsert user trait
  • Events
    • The Event object
    • GETList events
    • POSTCreate event
    • POSTCreate event batch
    • GETGet event
  • Features
    • The Feature object
    • GETList features
    • GETGet feature
    • POSTCreate feature
    • PUTUpdate feature
    • DELDelete feature
  • Flags
    • The Flag object
    • GETList flags
    • GETGet flag
    • POSTCreate flag
    • PUTUpdate flag
    • DELDelete flag
    • PUTUpdate flag rules
    • POSTCheck flag
    • POSTCheck flags
  • Entitlements
    • GETList company overrides
    • GETGet company override
    • POSTCreate company override
    • PUTUpdate company override
    • DELDelete company override
    • GETList plan entitlements
    • GETGet plan entitlement
    • POSTCreate plan entitlement
    • PUTUpdate plan entitlement
    • DELDelete plan entitlement
  • Feature Usage
    • GETList feature usage
  • Billing Credits
    • GETList credits
    • POSTCreate credit
    • GETGet credit
    • PUTUpdate credit
    • DELDelete credit
    • GETList credit bundles
    • POSTCreate credit bundle
    • GETGet credit bundle
    • PUTUpdate credit bundle
    • DELDelete credit bundle
    • POSTGrant credits to company
    • GETList company credit grants
    • GETList credit grants
    • PUTZero out credit grant
    • GETList plan credit grants
    • POSTCreate plan credit grant
    • DELDelete plan credit grant
    • GETGet credit ledger
  • Account Members
    • GETList account members
    • GETGet account member
LogoLogo
SupportDashboard
Feature Usage

List feature usage

GET
https://api.schematichq.com/feature-usage
GET
/feature-usage
1import { SchematicClient } from "@schematichq/schematic-typescript-node";
2
3async function main() {
4    const client = new SchematicClient({
5        apiKey: "YOUR_API_KEY_HERE",
6    });
7    await client.entitlements.listFeatureUsage({});
8}
9main();
1{
2  "data": [
3    {
4      "access": true,
5      "allocation_type": "boolean",
6      "entitlement_id": "string",
7      "entitlement_type": "company_override",
8      "allocation": 1,
9      "company_override": {
10        "company_id": "string",
11        "created_at": "2024-01-15T09:30:00Z",
12        "environment_id": "string",
13        "feature_id": "string",
14        "id": "string",
15        "notes": [
16          {
17            "created_at": "2024-01-15T09:30:00Z",
18            "external_user_id": "string",
19            "external_user_name": "string",
20            "id": "string",
21            "note": "string",
22            "updated_at": "2024-01-15T09:30:00Z"
23          }
24        ],
25        "updated_at": "2024-01-15T09:30:00Z",
26        "value_type": "boolean",
27        "company": {
28          "add_ons": [
29            {
30              "id": "string",
31              "included_credit_grants": [
32                {
33                  "billing_credit_auto_topup_enabled": true,
34                  "billing_credit_auto_topup_self_service": 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                  "rollover_percentage": 1,
42                  "updated_at": "2024-01-15T09:30:00Z",
43                  "credit_description": "string",
44                  "credit_name": "string",
45                  "billing_credit_auto_topup_amount": 1,
46                  "billing_credit_auto_topup_amount_type": "string",
47                  "billing_credit_auto_topup_expiry_type": "duration",
48                  "billing_credit_auto_topup_expiry_unit": "billing_periods",
49                  "billing_credit_auto_topup_expiry_unit_count": 1,
50                  "billing_credit_auto_topup_threshold_credits": 1,
51                  "billing_credit_auto_topup_threshold_percent": 1,
52                  "company_auto_topup_amount": 1,
53                  "company_auto_topup_enabled": true,
54                  "company_auto_topup_threshold_credits": 1,
55                  "credit": {
56                    "account_id": "string",
57                    "burn_strategy": "expiration_priority",
58                    "cost_editable": true,
59                    "created_at": "2024-01-15T09:30:00Z",
60                    "currency_prices": [
61                      {
62                        "currency": "string",
63                        "price": {
64                          "billing_scheme": "per_unit",
65                          "created_at": "2024-01-15T09:30:00Z",
66                          "currency": "string",
67                          "id": "string",
68                          "interval": "day",
69                          "interval_count": 1,
70                          "is_active": true,
71                          "package_size": 1,
72                          "price": 1,
73                          "price_external_id": "string",
74                          "price_id": "string",
75                          "price_tier": [
76                            {
77                              "flat_amount": 1,
78                              "per_unit_price": 1,
79                              "per_unit_price_decimal": "string",
80                              "up_to": 1
81                            }
82                          ],
83                          "product_external_id": "string",
84                          "product_id": "string",
85                          "product_name": "string",
86                          "provider_type": "metronome",
87                          "updated_at": "2024-01-15T09:30:00Z",
88                          "usage_type": "licensed",
89                          "meter_event_name": "string",
90                          "meter_event_payload_key": "string",
91                          "meter_id": "string",
92                          "nickname": "string",
93                          "price_decimal": "string",
94                          "tiers_mode": "graduated"
95                        }
96                      }
97                    ],
98                    "default_expiry_unit": "billing_periods",
99                    "default_rollover_policy": "expire",
100                    "description": "string",
101                    "environment_id": "string",
102                    "id": "string",
103                    "ledger_authority": "schematic_authoritative",
104                    "name": "string",
105                    "updated_at": "2024-01-15T09:30:00Z",
106                    "default_expiry_unit_count": 1,
107                    "icon": "string",
108                    "plural_name": "string",
109                    "price": {
110                      "billing_scheme": "per_unit",
111                      "created_at": "2024-01-15T09:30:00Z",
112                      "currency": "string",
113                      "id": "string",
114                      "interval": "day",
115                      "interval_count": 1,
116                      "is_active": true,
117                      "package_size": 1,
118                      "price": 1,
119                      "price_external_id": "string",
120                      "price_id": "string",
121                      "price_tier": [
122                        {
123                          "flat_amount": 1,
124                          "per_unit_price": 1,
125                          "per_unit_price_decimal": "string",
126                          "up_to": 1
127                        }
128                      ],
129                      "product_external_id": "string",
130                      "product_id": "string",
131                      "product_name": "string",
132                      "provider_type": "metronome",
133                      "updated_at": "2024-01-15T09:30:00Z",
134                      "usage_type": "licensed",
135                      "meter_event_name": "string",
136                      "meter_event_payload_key": "string",
137                      "meter_id": "string",
138                      "nickname": "string",
139                      "price_decimal": "string",
140                      "tiers_mode": "graduated"
141                    },
142                    "price_per_unit": 1,
143                    "price_per_unit_decimal": "string",
144                    "product": {
145                      "account_id": "string",
146                      "created_at": "2024-01-15T09:30:00Z",
147                      "environment_id": "string",
148                      "external_id": "string",
149                      "is_active": true,
150                      "name": "string",
151                      "price": 1.1,
152                      "product_id": "string",
153                      "provider_type": "metronome",
154                      "quantity": 1.1,
155                      "updated_at": "2024-01-15T09:30:00Z",
156                      "price_decimal": "string",
157                      "currency": "string"
158                    },
159                    "singular_name": "string"
160                  },
161                  "expiry_type": "duration",
162                  "expiry_unit": "billing_periods",
163                  "expiry_unit_count": 1,
164                  "plan": {
165                    "id": "string",
166                    "name": "string",
167                    "description": "string",
168                    "image_url": "string"
169                  },
170                  "plan_version_id": "string",
171                  "reset_cadence": "daily",
172                  "reset_start": "billing_period",
173                  "credit_icon": "string",
174                  "plural_name": "string",
175                  "singular_name": "string"
176                }
177              ],
178              "name": "string",
179              "added_on": "2024-01-15T09:30:00Z",
180              "billing_product_external_id": "string",
181              "billing_product_id": "string",
182              "description": "string",
183              "image_url": "string",
184              "plan_period": "string",
185              "plan_price": 1,
186              "plan_version_id": "string"
187            }
188          ],
189          "billing_subscriptions": [
190            {
191              "cancel_at_period_end": true,
192              "created_at": "2024-01-15T09:30:00Z",
193              "currency": "string",
194              "customer_external_id": "string",
195              "discounts": [
196                {
197                  "coupon_id": "string",
198                  "coupon_name": "string",
199                  "discount_external_id": "string",
200                  "duration": "string",
201                  "is_active": true,
202                  "started_at": "2024-01-15T09:30:00Z",
203                  "subscription_external_id": "string",
204                  "amount_off": 1,
205                  "currency": "string",
206                  "customer_facing_code": "string",
207                  "duration_in_months": 1,
208                  "ended_at": "2024-01-15T09:30:00Z",
209                  "percent_off": 1.1,
210                  "promo_code_external_id": "string"
211                }
212              ],
213              "id": "string",
214              "interval": "string",
215              "period_end": 1,
216              "period_start": 1,
217              "products": [
218                {
219                  "billing_scheme": "per_unit",
220                  "created_at": "2024-01-15T09:30:00Z",
221                  "currency": "string",
222                  "environment_id": "string",
223                  "external_id": "string",
224                  "id": "string",
225                  "interval": "string",
226                  "name": "string",
227                  "package_size": 1,
228                  "price": 1,
229                  "price_external_id": "string",
230                  "price_id": "string",
231                  "price_tier": [
232                    {
233                      "flat_amount": 1,
234                      "per_unit_price": 1,
235                      "per_unit_price_decimal": "string",
236                      "up_to": 1
237                    }
238                  ],
239                  "provider_type": "metronome",
240                  "quantity": 1.1,
241                  "subscription_id": "string",
242                  "updated_at": "2024-01-15T09:30:00Z",
243                  "usage_type": "licensed",
244                  "billing_threshold": 1,
245                  "interval_count": 1,
246                  "meter_id": "string",
247                  "price_decimal": "string",
248                  "subscription_item_external_id": "string"
249                }
250              ],
251              "provider_type": "metronome",
252              "status": "string",
253              "subscription_external_id": "string",
254              "total_price": 1,
255              "application_id": "string",
256              "cancel_at": 1,
257              "company_id": "string",
258              "default_payment_method_id": "string",
259              "expired_at": "2024-01-15T09:30:00Z",
260              "latest_invoice": {
261                "amount_due": 1,
262                "amount_paid": 1,
263                "amount_remaining": 1,
264                "collection_method": "string",
265                "created_at": "2024-01-15T09:30:00Z",
266                "currency": "string",
267                "customer_external_id": "string",
268                "environment_id": "string",
269                "id": "string",
270                "provider_type": "metronome",
271                "subtotal": 1,
272                "updated_at": "2024-01-15T09:30:00Z",
273                "company_id": "string",
274                "due_date": "2024-01-15T09:30:00Z",
275                "external_id": "string",
276                "payment_method_external_id": "string",
277                "status": "draft",
278                "subscription_external_id": "string",
279                "url": "string"
280              },
281              "metadata": {},
282              "payment_method": {
283                "created_at": "2024-01-15T09:30:00Z",
284                "customer_external_id": "string",
285                "environment_id": "string",
286                "external_id": "string",
287                "id": "string",
288                "payment_method_type": "string",
289                "provider_type": "metronome",
290                "updated_at": "2024-01-15T09:30:00Z",
291                "account_last4": "string",
292                "account_name": "string",
293                "bank_name": "string",
294                "billing_email": "string",
295                "billing_name": "string",
296                "card_brand": "string",
297                "card_exp_month": 1,
298                "card_exp_year": 1,
299                "card_last4": "string",
300                "company_id": "string"
301              },
302              "trial_end": 1,
303              "trial_end_setting": "cancel"
304            }
305          ],
306          "created_at": "2024-01-15T09:30:00Z",
307          "custom_plan_billings": [
308            {
309              "activation_strategy": "on_payment",
310              "company_id": "string",
311              "created_at": "2024-01-15T09:30:00Z",
312              "days_until_due": 1,
313              "id": "string",
314              "plan_id": "string",
315              "status": "active",
316              "updated_at": "2024-01-15T09:30:00Z",
317              "external_invoice_id": "string",
318              "paid_at": "2024-01-15T09:30:00Z",
319              "published_at": "2024-01-15T09:30:00Z",
320              "stripe_invoice_url": "string"
321            }
322          ],
323          "entitlements": [
324            {
325              "feature_id": "string",
326              "feature_key": "string",
327              "value_type": "boolean",
328              "allocation": 1,
329              "credit_id": "string",
330              "credit_remaining": 1.1,
331              "credit_total": 1.1,
332              "credit_used": 1.1,
333              "event_name": "string",
334              "metric_period": "all_time",
335              "metric_reset_at": "2024-01-15T09:30:00Z",
336              "month_reset": "billing_cycle",
337              "soft_limit": 1,
338              "usage": 1
339            }
340          ],
341          "entity_traits": [
342            {
343              "created_at": "2024-01-15T09:30:00Z",
344              "definition_id": "string",
345              "environment_id": "string",
346              "id": "string",
347              "updated_at": "2024-01-15T09:30:00Z",
348              "value": "string",
349              "definition": {
350                "created_at": "2024-01-15T09:30:00Z",
351                "display_name": "string",
352                "entity_type": "company",
353                "hierarchy": [
354                  "string"
355                ],
356                "id": "string",
357                "trait_type": "boolean",
358                "updated_at": "2024-01-15T09:30:00Z"
359              }
360            }
361          ],
362          "environment_id": "string",
363          "id": "string",
364          "keys": [
365            {
366              "created_at": "2024-01-15T09:30:00Z",
367              "definition_id": "string",
368              "entity_id": "string",
369              "entity_type": "company",
370              "environment_id": "string",
371              "id": "string",
372              "key": "string",
373              "updated_at": "2024-01-15T09:30:00Z",
374              "value": "string",
375              "definition": {
376                "created_at": "2024-01-15T09:30:00Z",
377                "entity_type": "company",
378                "id": "string",
379                "key": "string",
380                "updated_at": "2024-01-15T09:30:00Z"
381              }
382            }
383          ],
384          "metrics": [
385            {
386              "account_id": "string",
387              "captured_at_max": "2024-01-15T09:30:00Z",
388              "captured_at_min": "2024-01-15T09:30:00Z",
389              "company_id": "string",
390              "created_at": "2024-01-15T09:30:00Z",
391              "environment_id": "string",
392              "event_subtype": "string",
393              "month_reset": "billing_cycle",
394              "period": "all_time",
395              "value": 1,
396              "valid_until": "2024-01-15T09:30:00Z"
397            }
398          ],
399          "name": "string",
400          "payment_methods": [
401            {
402              "created_at": "2024-01-15T09:30:00Z",
403              "customer_external_id": "string",
404              "environment_id": "string",
405              "external_id": "string",
406              "id": "string",
407              "payment_method_type": "string",
408              "provider_type": "metronome",
409              "updated_at": "2024-01-15T09:30:00Z",
410              "account_last4": "string",
411              "account_name": "string",
412              "bank_name": "string",
413              "billing_email": "string",
414              "billing_name": "string",
415              "card_brand": "string",
416              "card_exp_month": 1,
417              "card_exp_year": 1,
418              "card_last4": "string",
419              "company_id": "string"
420            }
421          ],
422          "plans": [
423            {
424              "id": "string",
425              "name": "string",
426              "description": "string",
427              "image_url": "string"
428            }
429          ],
430          "rules": [
431            {
432              "account_id": "string",
433              "condition_groups": [
434                {
435                  "conditions": [
436                    {
437                      "account_id": "string",
438                      "condition_type": "base_plan",
439                      "environment_id": "string",
440                      "id": "string",
441                      "operator": "eq",
442                      "resource_ids": [
443                        "string"
444                      ],
445                      "trait_value": "string",
446                      "comparison_trait_definition": {
447                        "comparable_type": "bool",
448                        "entity_type": "company",
449                        "id": "string"
450                      },
451                      "consumption_rate": 1.1,
452                      "credit_id": "string",
453                      "event_subtype": "string",
454                      "metric_period": "all_time",
455                      "metric_period_month_reset": "billing_cycle",
456                      "metric_value": 1,
457                      "trait_definition": {
458                        "comparable_type": "bool",
459                        "entity_type": "company",
460                        "id": "string"
461                      }
462                    }
463                  ]
464                }
465              ],
466              "conditions": [
467                {
468                  "account_id": "string",
469                  "condition_type": "base_plan",
470                  "environment_id": "string",
471                  "id": "string",
472                  "operator": "eq",
473                  "resource_ids": [
474                    "string"
475                  ],
476                  "trait_value": "string",
477                  "comparison_trait_definition": {
478                    "comparable_type": "bool",
479                    "entity_type": "company",
480                    "id": "string"
481                  },
482                  "consumption_rate": 1.1,
483                  "credit_id": "string",
484                  "event_subtype": "string",
485                  "metric_period": "all_time",
486                  "metric_period_month_reset": "billing_cycle",
487                  "metric_value": 1,
488                  "trait_definition": {
489                    "comparable_type": "bool",
490                    "entity_type": "company",
491                    "id": "string"
492                  }
493                }
494              ],
495              "environment_id": "string",
496              "id": "string",
497              "name": "string",
498              "priority": 1,
499              "rule_type": "company_override",
500              "value": true,
501              "flag_id": "string"
502            }
503          ],
504          "updated_at": "2024-01-15T09:30:00Z",
505          "user_count": 1,
506          "billing_credit_balances": {},
507          "billing_subscription": {
508            "cancel_at_period_end": true,
509            "created_at": "2024-01-15T09:30:00Z",
510            "currency": "string",
511            "customer_external_id": "string",
512            "discounts": [
513              {
514                "coupon_id": "string",
515                "coupon_name": "string",
516                "discount_external_id": "string",
517                "duration": "string",
518                "is_active": true,
519                "started_at": "2024-01-15T09:30:00Z",
520                "subscription_external_id": "string",
521                "amount_off": 1,
522                "currency": "string",
523                "customer_facing_code": "string",
524                "duration_in_months": 1,
525                "ended_at": "2024-01-15T09:30:00Z",
526                "percent_off": 1.1,
527                "promo_code_external_id": "string"
528              }
529            ],
530            "id": "string",
531            "interval": "string",
532            "period_end": 1,
533            "period_start": 1,
534            "products": [
535              {
536                "billing_scheme": "per_unit",
537                "created_at": "2024-01-15T09:30:00Z",
538                "currency": "string",
539                "environment_id": "string",
540                "external_id": "string",
541                "id": "string",
542                "interval": "string",
543                "name": "string",
544                "package_size": 1,
545                "price": 1,
546                "price_external_id": "string",
547                "price_id": "string",
548                "price_tier": [
549                  {
550                    "flat_amount": 1,
551                    "per_unit_price": 1,
552                    "per_unit_price_decimal": "string",
553                    "up_to": 1
554                  }
555                ],
556                "provider_type": "metronome",
557                "quantity": 1.1,
558                "subscription_id": "string",
559                "updated_at": "2024-01-15T09:30:00Z",
560                "usage_type": "licensed",
561                "billing_threshold": 1,
562                "interval_count": 1,
563                "meter_id": "string",
564                "price_decimal": "string",
565                "subscription_item_external_id": "string"
566              }
567            ],
568            "provider_type": "metronome",
569            "status": "string",
570            "subscription_external_id": "string",
571            "total_price": 1,
572            "application_id": "string",
573            "cancel_at": 1,
574            "company_id": "string",
575            "default_payment_method_id": "string",
576            "expired_at": "2024-01-15T09:30:00Z",
577            "latest_invoice": {
578              "amount_due": 1,
579              "amount_paid": 1,
580              "amount_remaining": 1,
581              "collection_method": "string",
582              "created_at": "2024-01-15T09:30:00Z",
583              "currency": "string",
584              "customer_external_id": "string",
585              "environment_id": "string",
586              "id": "string",
587              "provider_type": "metronome",
588              "subtotal": 1,
589              "updated_at": "2024-01-15T09:30:00Z",
590              "company_id": "string",
591              "due_date": "2024-01-15T09:30:00Z",
592              "external_id": "string",
593              "payment_method_external_id": "string",
594              "status": "draft",
595              "subscription_external_id": "string",
596              "url": "string"
597            },
598            "metadata": {},
599            "payment_method": {
600              "created_at": "2024-01-15T09:30:00Z",
601              "customer_external_id": "string",
602              "environment_id": "string",
603              "external_id": "string",
604              "id": "string",
605              "payment_method_type": "string",
606              "provider_type": "metronome",
607              "updated_at": "2024-01-15T09:30:00Z",
608              "account_last4": "string",
609              "account_name": "string",
610              "bank_name": "string",
611              "billing_email": "string",
612              "billing_name": "string",
613              "card_brand": "string",
614              "card_exp_month": 1,
615              "card_exp_year": 1,
616              "card_last4": "string",
617              "company_id": "string"
618            },
619            "trial_end": 1,
620            "trial_end_setting": "cancel"
621          },
622          "default_payment_method": {
623            "created_at": "2024-01-15T09:30:00Z",
624            "customer_external_id": "string",
625            "environment_id": "string",
626            "external_id": "string",
627            "id": "string",
628            "payment_method_type": "string",
629            "provider_type": "metronome",
630            "updated_at": "2024-01-15T09:30:00Z",
631            "account_last4": "string",
632            "account_name": "string",
633            "bank_name": "string",
634            "billing_email": "string",
635            "billing_name": "string",
636            "card_brand": "string",
637            "card_exp_month": 1,
638            "card_exp_year": 1,
639            "card_last4": "string",
640            "company_id": "string"
641          },
642          "last_seen_at": "2024-01-15T09:30:00Z",
643          "logo_url": "string",
644          "plan": {
645            "id": "string",
646            "included_credit_grants": [
647              {
648                "billing_credit_auto_topup_enabled": true,
649                "billing_credit_auto_topup_self_service": true,
650                "created_at": "2024-01-15T09:30:00Z",
651                "credit_amount": 1,
652                "credit_id": "string",
653                "id": "string",
654                "plan_id": "string",
655                "reset_type": "no_reset",
656                "rollover_percentage": 1,
657                "updated_at": "2024-01-15T09:30:00Z",
658                "credit_description": "string",
659                "credit_name": "string",
660                "billing_credit_auto_topup_amount": 1,
661                "billing_credit_auto_topup_amount_type": "string",
662                "billing_credit_auto_topup_expiry_type": "duration",
663                "billing_credit_auto_topup_expiry_unit": "billing_periods",
664                "billing_credit_auto_topup_expiry_unit_count": 1,
665                "billing_credit_auto_topup_threshold_credits": 1,
666                "billing_credit_auto_topup_threshold_percent": 1,
667                "company_auto_topup_amount": 1,
668                "company_auto_topup_enabled": true,
669                "company_auto_topup_threshold_credits": 1,
670                "credit": {
671                  "account_id": "string",
672                  "burn_strategy": "expiration_priority",
673                  "cost_editable": true,
674                  "created_at": "2024-01-15T09:30:00Z",
675                  "currency_prices": [
676                    {
677                      "currency": "string",
678                      "price": {
679                        "billing_scheme": "per_unit",
680                        "created_at": "2024-01-15T09:30:00Z",
681                        "currency": "string",
682                        "id": "string",
683                        "interval": "day",
684                        "interval_count": 1,
685                        "is_active": true,
686                        "package_size": 1,
687                        "price": 1,
688                        "price_external_id": "string",
689                        "price_id": "string",
690                        "price_tier": [
691                          {
692                            "flat_amount": 1,
693                            "per_unit_price": 1,
694                            "per_unit_price_decimal": "string",
695                            "up_to": 1
696                          }
697                        ],
698                        "product_external_id": "string",
699                        "product_id": "string",
700                        "product_name": "string",
701                        "provider_type": "metronome",
702                        "updated_at": "2024-01-15T09:30:00Z",
703                        "usage_type": "licensed",
704                        "meter_event_name": "string",
705                        "meter_event_payload_key": "string",
706                        "meter_id": "string",
707                        "nickname": "string",
708                        "price_decimal": "string",
709                        "tiers_mode": "graduated"
710                      }
711                    }
712                  ],
713                  "default_expiry_unit": "billing_periods",
714                  "default_rollover_policy": "expire",
715                  "description": "string",
716                  "environment_id": "string",
717                  "id": "string",
718                  "ledger_authority": "schematic_authoritative",
719                  "name": "string",
720                  "updated_at": "2024-01-15T09:30:00Z",
721                  "default_expiry_unit_count": 1,
722                  "icon": "string",
723                  "plural_name": "string",
724                  "price": {
725                    "billing_scheme": "per_unit",
726                    "created_at": "2024-01-15T09:30:00Z",
727                    "currency": "string",
728                    "id": "string",
729                    "interval": "day",
730                    "interval_count": 1,
731                    "is_active": true,
732                    "package_size": 1,
733                    "price": 1,
734                    "price_external_id": "string",
735                    "price_id": "string",
736                    "price_tier": [
737                      {
738                        "flat_amount": 1,
739                        "per_unit_price": 1,
740                        "per_unit_price_decimal": "string",
741                        "up_to": 1
742                      }
743                    ],
744                    "product_external_id": "string",
745                    "product_id": "string",
746                    "product_name": "string",
747                    "provider_type": "metronome",
748                    "updated_at": "2024-01-15T09:30:00Z",
749                    "usage_type": "licensed",
750                    "meter_event_name": "string",
751                    "meter_event_payload_key": "string",
752                    "meter_id": "string",
753                    "nickname": "string",
754                    "price_decimal": "string",
755                    "tiers_mode": "graduated"
756                  },
757                  "price_per_unit": 1,
758                  "price_per_unit_decimal": "string",
759                  "product": {
760                    "account_id": "string",
761                    "created_at": "2024-01-15T09:30:00Z",
762                    "environment_id": "string",
763                    "external_id": "string",
764                    "is_active": true,
765                    "name": "string",
766                    "price": 1.1,
767                    "product_id": "string",
768                    "provider_type": "metronome",
769                    "quantity": 1.1,
770                    "updated_at": "2024-01-15T09:30:00Z",
771                    "price_decimal": "string",
772                    "currency": "string"
773                  },
774                  "singular_name": "string"
775                },
776                "expiry_type": "duration",
777                "expiry_unit": "billing_periods",
778                "expiry_unit_count": 1,
779                "plan": {
780                  "id": "string",
781                  "name": "string",
782                  "description": "string",
783                  "image_url": "string"
784                },
785                "plan_version_id": "string",
786                "reset_cadence": "daily",
787                "reset_start": "billing_period",
788                "credit_icon": "string",
789                "plural_name": "string",
790                "singular_name": "string"
791              }
792            ],
793            "name": "string",
794            "added_on": "2024-01-15T09:30:00Z",
795            "billing_product_external_id": "string",
796            "billing_product_id": "string",
797            "description": "string",
798            "image_url": "string",
799            "plan_period": "string",
800            "plan_price": 1,
801            "plan_version_id": "string"
802          },
803          "scheduled_downgrade": {
804            "currency": "string",
805            "effective_after": "2024-01-15T09:30:00Z",
806            "from_plan_id": "string",
807            "from_plan_name": "string",
808            "from_subscription_price": 1,
809            "id": "string",
810            "interval": "string",
811            "to_plan_id": "string",
812            "to_plan_name": "string",
813            "scheduled_interval": "string",
814            "scheduled_price": 1
815          },
816          "traits": {}
817        },
818        "consumption_rate": 1.1,
819        "expiration_date": "2024-01-15T09:30:00Z",
820        "feature": {
821          "created_at": "2024-01-15T09:30:00Z",
822          "description": "string",
823          "feature_type": "boolean",
824          "icon": "string",
825          "id": "string",
826          "name": "string",
827          "updated_at": "2024-01-15T09:30:00Z",
828          "event_subtype": "string",
829          "lifecycle_phase": "add_on",
830          "maintainer_account_member_id": "string",
831          "plural_name": "string",
832          "singular_name": "string",
833          "trait_id": "string"
834        },
835        "metric_period": "all_time",
836        "metric_period_month_reset": "billing_cycle",
837        "rule_id": "string",
838        "rule_id_usage_exceeded": "string",
839        "value_bool": true,
840        "value_numeric": 1,
841        "value_trait": {
842          "created_at": "2024-01-15T09:30:00Z",
843          "display_name": "string",
844          "entity_type": "company",
845          "hierarchy": [
846            "string"
847          ],
848          "id": "string",
849          "trait_type": "boolean",
850          "updated_at": "2024-01-15T09:30:00Z"
851        },
852        "value_trait_id": "string"
853      },
854      "credit_consumption_rate": 1.1,
855      "credit_grant_counts": {},
856      "credit_grant_details": [
857        {
858          "grant_reason": "adjustment",
859          "quantity": 1.1,
860          "credit_type_icon": "string",
861          "expires_at": "2024-01-15T09:30:00Z"
862        }
863      ],
864      "credit_grant_reason": "adjustment",
865      "credit_remaining": 1.1,
866      "credit_type_icon": "string",
867      "credit_usage_aggregation": {
868        "usage_this_billing_period": 1.1,
869        "usage_this_calendar_month": 1.1,
870        "usage_this_week": 1.1,
871        "usage_today": 1.1
872      },
873      "credit_used": 1.1,
874      "effective_limit": 1,
875      "effective_price": 1.1,
876      "entitlement_expiration_date": "2024-01-15T09:30:00Z",
877      "entitlement_source": "string",
878      "feature": {
879        "created_at": "2024-01-15T09:30:00Z",
880        "description": "string",
881        "feature_type": "boolean",
882        "flags": [
883          {
884            "created_at": "2024-01-15T09:30:00Z",
885            "default_value": true,
886            "description": "string",
887            "flag_type": "boolean",
888            "id": "string",
889            "key": "string",
890            "name": "string",
891            "rules": [
892              {
893                "condition_groups": [
894                  {
895                    "conditions": [
896                      {
897                        "condition_type": "base_plan",
898                        "created_at": "2024-01-15T09:30:00Z",
899                        "environment_id": "string",
900                        "id": "string",
901                        "operator": "eq",
902                        "resource_ids": [
903                          "string"
904                        ],
905                        "resources": [
906                          {
907                            "id": "string",
908                            "name": "string",
909                            "description": "string",
910                            "image_url": "string"
911                          }
912                        ],
913                        "rule_id": "string",
914                        "trait_value": "string",
915                        "updated_at": "2024-01-15T09:30:00Z",
916                        "comparison_trait": {
917                          "created_at": "2024-01-15T09:30:00Z",
918                          "display_name": "string",
919                          "entity_type": "company",
920                          "hierarchy": [
921                            "string"
922                          ],
923                          "id": "string",
924                          "trait_type": "boolean",
925                          "updated_at": "2024-01-15T09:30:00Z"
926                        },
927                        "comparison_trait_id": "string",
928                        "condition_group_id": "string",
929                        "event_subtype": "string",
930                        "flag_id": "string",
931                        "metric_period": "all_time",
932                        "metric_period_month_reset": "billing_cycle",
933                        "metric_value": 1,
934                        "trait": {
935                          "created_at": "2024-01-15T09:30:00Z",
936                          "display_name": "string",
937                          "entity_type": "company",
938                          "hierarchy": [
939                            "string"
940                          ],
941                          "id": "string",
942                          "trait_type": "boolean",
943                          "updated_at": "2024-01-15T09:30:00Z"
944                        },
945                        "trait_entity_type": "company",
946                        "trait_id": "string"
947                      }
948                    ],
949                    "created_at": "2024-01-15T09:30:00Z",
950                    "environment_id": "string",
951                    "id": "string",
952                    "rule_id": "string",
953                    "updated_at": "2024-01-15T09:30:00Z",
954                    "flag_id": "string"
955                  }
956                ],
957                "conditions": [
958                  {
959                    "condition_type": "base_plan",
960                    "created_at": "2024-01-15T09:30:00Z",
961                    "environment_id": "string",
962                    "id": "string",
963                    "operator": "eq",
964                    "resource_ids": [
965                      "string"
966                    ],
967                    "resources": [
968                      {
969                        "id": "string",
970                        "name": "string",
971                        "description": "string",
972                        "image_url": "string"
973                      }
974                    ],
975                    "rule_id": "string",
976                    "trait_value": "string",
977                    "updated_at": "2024-01-15T09:30:00Z",
978                    "comparison_trait": {
979                      "created_at": "2024-01-15T09:30:00Z",
980                      "display_name": "string",
981                      "entity_type": "company",
982                      "hierarchy": [
983                        "string"
984                      ],
985                      "id": "string",
986                      "trait_type": "boolean",
987                      "updated_at": "2024-01-15T09:30:00Z"
988                    },
989                    "comparison_trait_id": "string",
990                    "condition_group_id": "string",
991                    "event_subtype": "string",
992                    "flag_id": "string",
993                    "metric_period": "all_time",
994                    "metric_period_month_reset": "billing_cycle",
995                    "metric_value": 1,
996                    "trait": {
997                      "created_at": "2024-01-15T09:30:00Z",
998                      "display_name": "string",
999                      "entity_type": "company",
1000                      "hierarchy": [
1001                        "string"
1002                      ],
1003                      "id": "string",
1004                      "trait_type": "boolean",
1005                      "updated_at": "2024-01-15T09:30:00Z"
1006                    },
1007                    "trait_entity_type": "company",
1008                    "trait_id": "string"
1009                  }
1010                ],
1011                "created_at": "2024-01-15T09:30:00Z",
1012                "environment_id": "string",
1013                "id": "string",
1014                "name": "string",
1015                "priority": 1,
1016                "rule_type": "company_override",
1017                "updated_at": "2024-01-15T09:30:00Z",
1018                "value": true,
1019                "flag_id": "string"
1020              }
1021            ],
1022            "updated_at": "2024-01-15T09:30:00Z",
1023            "feature": {
1024              "created_at": "2024-01-15T09:30:00Z",
1025              "description": "string",
1026              "feature_type": "boolean",
1027              "icon": "string",
1028              "id": "string",
1029              "name": "string",
1030              "updated_at": "2024-01-15T09:30:00Z",
1031              "event_subtype": "string",
1032              "lifecycle_phase": "add_on",
1033              "maintainer_account_member_id": "string",
1034              "plural_name": "string",
1035              "singular_name": "string",
1036              "trait_id": "string"
1037            },
1038            "feature_id": "string",
1039            "last_checked_at": "2024-01-15T09:30:00Z",
1040            "maintainer_account_member_id": "string"
1041          }
1042        ],
1043        "icon": "string",
1044        "id": "string",
1045        "name": "string",
1046        "plans": [
1047          {
1048            "id": "string",
1049            "name": "string",
1050            "description": "string",
1051            "image_url": "string"
1052          }
1053        ],
1054        "updated_at": "2024-01-15T09:30:00Z",
1055        "billing_linked_resource": {
1056          "billing_provider": "metronome",
1057          "external_resource_id": "string",
1058          "originator": "metronome"
1059        },
1060        "event_subtype": "string",
1061        "event_summary": {
1062          "company_count": 1,
1063          "environment_id": "string",
1064          "event_count": 1,
1065          "event_subtype": "string",
1066          "user_count": 1,
1067          "last_seen_at": "2024-01-15T09:30:00Z"
1068        },
1069        "lifecycle_phase": "add_on",
1070        "maintainer_account_member_id": "string",
1071        "plural_name": "string",
1072        "singular_name": "string",
1073        "trait": {
1074          "created_at": "2024-01-15T09:30:00Z",
1075          "display_name": "string",
1076          "entity_type": "company",
1077          "hierarchy": [
1078            "string"
1079          ],
1080          "id": "string",
1081          "trait_type": "boolean",
1082          "updated_at": "2024-01-15T09:30:00Z"
1083        },
1084        "trait_id": "string"
1085      },
1086      "has_valid_allocation": true,
1087      "is_unlimited": true,
1088      "metric_reset_at": "2024-01-15T09:30:00Z",
1089      "month_reset": "billing_cycle",
1090      "monthly_usage_based_price": {
1091        "billing_scheme": "per_unit",
1092        "created_at": "2024-01-15T09:30:00Z",
1093        "currency": "string",
1094        "id": "string",
1095        "interval": "day",
1096        "interval_count": 1,
1097        "is_active": true,
1098        "package_size": 1,
1099        "price": 1,
1100        "price_external_id": "string",
1101        "price_id": "string",
1102        "price_tier": [
1103          {
1104            "flat_amount": 1,
1105            "per_unit_price": 1,
1106            "per_unit_price_decimal": "string",
1107            "up_to": 1
1108          }
1109        ],
1110        "product_external_id": "string",
1111        "product_id": "string",
1112        "product_name": "string",
1113        "provider_type": "metronome",
1114        "updated_at": "2024-01-15T09:30:00Z",
1115        "usage_type": "licensed",
1116        "meter_event_name": "string",
1117        "meter_event_payload_key": "string",
1118        "meter_id": "string",
1119        "nickname": "string",
1120        "price_decimal": "string",
1121        "tiers_mode": "graduated"
1122      },
1123      "overuse": 1,
1124      "percent_used": 1.1,
1125      "period": "all_time",
1126      "plan": {
1127        "created_at": "2024-01-15T09:30:00Z",
1128        "description": "string",
1129        "icon": "amber",
1130        "id": "string",
1131        "name": "string",
1132        "plan_type": "plan",
1133        "updated_at": "2024-01-15T09:30:00Z",
1134        "company_id": "string",
1135        "copied_from_plan_id": "string",
1136        "audience_type": "string"
1137      },
1138      "plan_entitlement": {
1139        "created_at": "2024-01-15T09:30:00Z",
1140        "currency_prices": [
1141          {
1142            "currency": "string",
1143            "monthly_price": {
1144              "billing_scheme": "per_unit",
1145              "created_at": "2024-01-15T09:30:00Z",
1146              "currency": "string",
1147              "id": "string",
1148              "interval": "day",
1149              "interval_count": 1,
1150              "is_active": true,
1151              "package_size": 1,
1152              "price": 1,
1153              "price_external_id": "string",
1154              "price_id": "string",
1155              "price_tier": [
1156                {
1157                  "flat_amount": 1,
1158                  "per_unit_price": 1,
1159                  "per_unit_price_decimal": "string",
1160                  "up_to": 1
1161                }
1162              ],
1163              "product_external_id": "string",
1164              "product_id": "string",
1165              "product_name": "string",
1166              "provider_type": "metronome",
1167              "updated_at": "2024-01-15T09:30:00Z",
1168              "usage_type": "licensed",
1169              "meter_event_name": "string",
1170              "meter_event_payload_key": "string",
1171              "meter_id": "string",
1172              "nickname": "string",
1173              "price_decimal": "string",
1174              "tiers_mode": "graduated"
1175            },
1176            "quarterly_price": {
1177              "billing_scheme": "per_unit",
1178              "created_at": "2024-01-15T09:30:00Z",
1179              "currency": "string",
1180              "id": "string",
1181              "interval": "day",
1182              "interval_count": 1,
1183              "is_active": true,
1184              "package_size": 1,
1185              "price": 1,
1186              "price_external_id": "string",
1187              "price_id": "string",
1188              "price_tier": [
1189                {
1190                  "flat_amount": 1,
1191                  "per_unit_price": 1,
1192                  "per_unit_price_decimal": "string",
1193                  "up_to": 1
1194                }
1195              ],
1196              "product_external_id": "string",
1197              "product_id": "string",
1198              "product_name": "string",
1199              "provider_type": "metronome",
1200              "updated_at": "2024-01-15T09:30:00Z",
1201              "usage_type": "licensed",
1202              "meter_event_name": "string",
1203              "meter_event_payload_key": "string",
1204              "meter_id": "string",
1205              "nickname": "string",
1206              "price_decimal": "string",
1207              "tiers_mode": "graduated"
1208            },
1209            "yearly_price": {
1210              "billing_scheme": "per_unit",
1211              "created_at": "2024-01-15T09:30:00Z",
1212              "currency": "string",
1213              "id": "string",
1214              "interval": "day",
1215              "interval_count": 1,
1216              "is_active": true,
1217              "package_size": 1,
1218              "price": 1,
1219              "price_external_id": "string",
1220              "price_id": "string",
1221              "price_tier": [
1222                {
1223                  "flat_amount": 1,
1224                  "per_unit_price": 1,
1225                  "per_unit_price_decimal": "string",
1226                  "up_to": 1
1227                }
1228              ],
1229              "product_external_id": "string",
1230              "product_id": "string",
1231              "product_name": "string",
1232              "provider_type": "metronome",
1233              "updated_at": "2024-01-15T09:30:00Z",
1234              "usage_type": "licensed",
1235              "meter_event_name": "string",
1236              "meter_event_payload_key": "string",
1237              "meter_id": "string",
1238              "nickname": "string",
1239              "price_decimal": "string",
1240              "tiers_mode": "graduated"
1241            }
1242          }
1243        ],
1244        "environment_id": "string",
1245        "feature_id": "string",
1246        "id": "string",
1247        "plan_id": "string",
1248        "rule_id": "string",
1249        "updated_at": "2024-01-15T09:30:00Z",
1250        "value_type": "boolean",
1251        "billing_linked_resource": {
1252          "billing_provider": "metronome",
1253          "external_resource_id": "string",
1254          "originator": "metronome"
1255        },
1256        "billing_threshold": 1,
1257        "consumption_rate": 1.1,
1258        "feature": {
1259          "created_at": "2024-01-15T09:30:00Z",
1260          "description": "string",
1261          "feature_type": "boolean",
1262          "icon": "string",
1263          "id": "string",
1264          "name": "string",
1265          "updated_at": "2024-01-15T09:30:00Z",
1266          "event_subtype": "string",
1267          "lifecycle_phase": "add_on",
1268          "maintainer_account_member_id": "string",
1269          "plural_name": "string",
1270          "singular_name": "string",
1271          "trait_id": "string"
1272        },
1273        "metered_monthly_price": {
1274          "billing_scheme": "per_unit",
1275          "created_at": "2024-01-15T09:30:00Z",
1276          "currency": "string",
1277          "id": "string",
1278          "interval": "day",
1279          "interval_count": 1,
1280          "is_active": true,
1281          "package_size": 1,
1282          "price": 1,
1283          "price_external_id": "string",
1284          "price_id": "string",
1285          "price_tier": [
1286            {
1287              "flat_amount": 1,
1288              "per_unit_price": 1,
1289              "per_unit_price_decimal": "string",
1290              "up_to": 1
1291            }
1292          ],
1293          "product_external_id": "string",
1294          "product_id": "string",
1295          "product_name": "string",
1296          "provider_type": "metronome",
1297          "updated_at": "2024-01-15T09:30:00Z",
1298          "usage_type": "licensed",
1299          "meter_event_name": "string",
1300          "meter_event_payload_key": "string",
1301          "meter_id": "string",
1302          "nickname": "string",
1303          "price_decimal": "string",
1304          "tiers_mode": "graduated"
1305        },
1306        "metered_quarterly_price": {
1307          "billing_scheme": "per_unit",
1308          "created_at": "2024-01-15T09:30:00Z",
1309          "currency": "string",
1310          "id": "string",
1311          "interval": "day",
1312          "interval_count": 1,
1313          "is_active": true,
1314          "package_size": 1,
1315          "price": 1,
1316          "price_external_id": "string",
1317          "price_id": "string",
1318          "price_tier": [
1319            {
1320              "flat_amount": 1,
1321              "per_unit_price": 1,
1322              "per_unit_price_decimal": "string",
1323              "up_to": 1
1324            }
1325          ],
1326          "product_external_id": "string",
1327          "product_id": "string",
1328          "product_name": "string",
1329          "provider_type": "metronome",
1330          "updated_at": "2024-01-15T09:30:00Z",
1331          "usage_type": "licensed",
1332          "meter_event_name": "string",
1333          "meter_event_payload_key": "string",
1334          "meter_id": "string",
1335          "nickname": "string",
1336          "price_decimal": "string",
1337          "tiers_mode": "graduated"
1338        },
1339        "metered_yearly_price": {
1340          "billing_scheme": "per_unit",
1341          "created_at": "2024-01-15T09:30:00Z",
1342          "currency": "string",
1343          "id": "string",
1344          "interval": "day",
1345          "interval_count": 1,
1346          "is_active": true,
1347          "package_size": 1,
1348          "price": 1,
1349          "price_external_id": "string",
1350          "price_id": "string",
1351          "price_tier": [
1352            {
1353              "flat_amount": 1,
1354              "per_unit_price": 1,
1355              "per_unit_price_decimal": "string",
1356              "up_to": 1
1357            }
1358          ],
1359          "product_external_id": "string",
1360          "product_id": "string",
1361          "product_name": "string",
1362          "provider_type": "metronome",
1363          "updated_at": "2024-01-15T09:30:00Z",
1364          "usage_type": "licensed",
1365          "meter_event_name": "string",
1366          "meter_event_payload_key": "string",
1367          "meter_id": "string",
1368          "nickname": "string",
1369          "price_decimal": "string",
1370          "tiers_mode": "graduated"
1371        },
1372        "metric_period": "all_time",
1373        "metric_period_month_reset": "billing_cycle",
1374        "plan": {
1375          "created_at": "2024-01-15T09:30:00Z",
1376          "description": "string",
1377          "icon": "amber",
1378          "id": "string",
1379          "name": "string",
1380          "plan_type": "plan",
1381          "updated_at": "2024-01-15T09:30:00Z",
1382          "company_id": "string",
1383          "copied_from_plan_id": "string",
1384          "audience_type": "string"
1385        },
1386        "price_behavior": "credit_burndown",
1387        "rule_id_usage_exceeded": "string",
1388        "soft_limit": 1,
1389        "usage_based_product": {
1390          "account_id": "string",
1391          "created_at": "2024-01-15T09:30:00Z",
1392          "environment_id": "string",
1393          "external_id": "string",
1394          "is_active": true,
1395          "name": "string",
1396          "price": 1.1,
1397          "product_id": "string",
1398          "provider_type": "metronome",
1399          "quantity": 1.1,
1400          "updated_at": "2024-01-15T09:30:00Z",
1401          "price_decimal": "string",
1402          "currency": "string"
1403        },
1404        "usage_quantity": 1,
1405        "value_bool": true,
1406        "value_credit": {
1407          "burn_strategy": "expiration_priority",
1408          "cost_editable": true,
1409          "created_at": "2024-01-15T09:30:00Z",
1410          "currency_prices": [
1411            {
1412              "currency": "string",
1413              "price": {
1414                "currency": "string",
1415                "external_price_id": "string",
1416                "id": "string",
1417                "interval": "day",
1418                "interval_count": 1,
1419                "price": 1,
1420                "provider_type": "metronome",
1421                "scheme": "per_unit",
1422                "nickname": "string",
1423                "price_decimal": "string"
1424              }
1425            }
1426          ],
1427          "default_expiry_unit": "billing_periods",
1428          "default_rollover_policy": "expire",
1429          "description": "string",
1430          "id": "string",
1431          "name": "string",
1432          "updated_at": "2024-01-15T09:30:00Z",
1433          "default_expiry_unit_count": 1,
1434          "icon": "string",
1435          "plural_name": "string",
1436          "price": {
1437            "currency": "string",
1438            "external_price_id": "string",
1439            "id": "string",
1440            "interval": "day",
1441            "interval_count": 1,
1442            "price": 1,
1443            "provider_type": "metronome",
1444            "scheme": "per_unit",
1445            "nickname": "string",
1446            "price_decimal": "string"
1447          },
1448          "product": {
1449            "account_id": "string",
1450            "created_at": "2024-01-15T09:30:00Z",
1451            "environment_id": "string",
1452            "external_id": "string",
1453            "is_active": true,
1454            "name": "string",
1455            "price": 1.1,
1456            "product_id": "string",
1457            "provider_type": "metronome",
1458            "quantity": 1.1,
1459            "updated_at": "2024-01-15T09:30:00Z",
1460            "price_decimal": "string",
1461            "currency": "string"
1462          },
1463          "singular_name": "string"
1464        },
1465        "value_numeric": 1,
1466        "value_trait": {
1467          "created_at": "2024-01-15T09:30:00Z",
1468          "display_name": "string",
1469          "entity_type": "company",
1470          "hierarchy": [
1471            "string"
1472          ],
1473          "id": "string",
1474          "trait_type": "boolean",
1475          "updated_at": "2024-01-15T09:30:00Z"
1476        },
1477        "value_trait_id": "string"
1478      },
1479      "price_behavior": "credit_burndown",
1480      "quarterly_usage_based_price": {
1481        "billing_scheme": "per_unit",
1482        "created_at": "2024-01-15T09:30:00Z",
1483        "currency": "string",
1484        "id": "string",
1485        "interval": "day",
1486        "interval_count": 1,
1487        "is_active": true,
1488        "package_size": 1,
1489        "price": 1,
1490        "price_external_id": "string",
1491        "price_id": "string",
1492        "price_tier": [
1493          {
1494            "flat_amount": 1,
1495            "per_unit_price": 1,
1496            "per_unit_price_decimal": "string",
1497            "up_to": 1
1498          }
1499        ],
1500        "product_external_id": "string",
1501        "product_id": "string",
1502        "product_name": "string",
1503        "provider_type": "metronome",
1504        "updated_at": "2024-01-15T09:30:00Z",
1505        "usage_type": "licensed",
1506        "meter_event_name": "string",
1507        "meter_event_payload_key": "string",
1508        "meter_id": "string",
1509        "nickname": "string",
1510        "price_decimal": "string",
1511        "tiers_mode": "graduated"
1512      },
1513      "soft_limit": 1,
1514      "usage": 1,
1515      "yearly_usage_based_price": {
1516        "billing_scheme": "per_unit",
1517        "created_at": "2024-01-15T09:30:00Z",
1518        "currency": "string",
1519        "id": "string",
1520        "interval": "day",
1521        "interval_count": 1,
1522        "is_active": true,
1523        "package_size": 1,
1524        "price": 1,
1525        "price_external_id": "string",
1526        "price_id": "string",
1527        "price_tier": [
1528          {
1529            "flat_amount": 1,
1530            "per_unit_price": 1,
1531            "per_unit_price_decimal": "string",
1532            "up_to": 1
1533          }
1534        ],
1535        "product_external_id": "string",
1536        "product_id": "string",
1537        "product_name": "string",
1538        "provider_type": "metronome",
1539        "updated_at": "2024-01-15T09:30:00Z",
1540        "usage_type": "licensed",
1541        "meter_event_name": "string",
1542        "meter_event_payload_key": "string",
1543        "meter_id": "string",
1544        "nickname": "string",
1545        "price_decimal": "string",
1546        "tiers_mode": "graduated"
1547      },
1548      "credit_total": 1.1
1549    }
1550  ],
1551  "params": {
1552    "company_id": "string",
1553    "company_keys": {},
1554    "feature_ids": [
1555      "string"
1556    ],
1557    "include_usage_aggregation": true,
1558    "limit": 100,
1559    "managed_by": "metronome",
1560    "offset": 0,
1561    "q": "string",
1562    "without_negative_entitlements": true
1563  }
1564}
Was this page helpful?
Previous

List credits

Next
Built with

Authentication

X-Schematic-Api-Keystring
API Key authentication via header

Query parameters

company_idstringOptional
company_keysmap from strings to stringsOptional
feature_idslist of stringsOptional
include_usage_aggregationbooleanOptional

Include time-bucketed usage aggregation (today, this week, this month, billing period) for credit-based entitlements. Defaults to false for performance.

managed_byenumOptional

Filter for features managed by a billing provider, or by Schematic (no billing provider)

Allowed values:
qstringOptional
without_negative_entitlementsbooleanOptional
limitlongOptional

Page limit (default 100)

offsetlongOptional

Page offset (default 0)

Response

OK
datalist of objects
paramsobject
Input parameters

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
500
Internal Server Error