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