---
title: "Get feature usage by company"
method: GET
path: "/usage-by-company"
tags: ["entitlements"]
---

# Get feature usage by company

`GET /usage-by-company`

## Query parameters

- `keys` object, required

## Response `200`

OK

- object
  - `data` FeatureUsageDetailResponseData, required
    - `features` FeatureUsageResponseData[], required
      - `access` boolean, required — Whether further usage is permitted.
      - `allocation` integer, nullable — The maximum amount of usage that is permitted; a null value indicates that unlimited usage is permitted or that this is a credit-based entitlement (use credit_remaining instead).
      - `allocation_type` 'boolean' | 'credit' | 'numeric' | 'trait' | 'unknown' | 'unlimited', required
      - `company_override` CompanyOverrideResponseData
        - `company` CompanyDetailResponseData
          - `add_ons` CompanyPlanWithBillingSubView[], required
            - `added_on` string, date-time, nullable
            - `billing_product_external_id` string, nullable
            - `billing_product_id` string, nullable
            - `description` string, nullable
            - `id` string, required
            - `image_url` string, nullable
            - `included_credit_grants` CompanyPlanCreditGrantView[], required
              - …
            - `name` string, required
            - `plan_period` string, nullable
            - `plan_price` integer, nullable
            - `plan_version_id` string, nullable
          - `billing_credit_balances` object, nullable
          - `billing_subscription` BillingSubscriptionView
            - `application_id` string, nullable
            - `cancel_at` integer, nullable
            - `cancel_at_period_end` boolean, required
            - `company_id` string, nullable
            - `created_at` string, date-time, required
            - `currency` string, required
            - `customer_external_id` string, required
            - `default_payment_method_id` string, nullable
            - `discounts` BillingSubscriptionDiscountView[], required
              - …
            - `expired_at` string, date-time, nullable
            - `id` string, required
            - `interval` string, required
            - `latest_invoice` InvoiceResponseData
              - …
            - `metadata` object
            - `payment_method` PaymentMethodResponseData
              - …
            - `period_end` integer, required
            - `period_start` integer, required
            - `products` BillingProductForSubscriptionResponseData[], required
              - …
            - `provider_type` 'metronome' | 'orb' | 'schematic' | 'stripe', required
            - `status` string, required
            - `subscription_external_id` string, required
            - `total_price` integer, required
            - `trial_end` integer, nullable
            - `trial_end_setting` 'cancel' | 'subscribe'
          - `billing_subscriptions` BillingSubscriptionView[], required
            - `application_id` string, nullable
            - `cancel_at` integer, nullable
            - `cancel_at_period_end` boolean, required
            - `company_id` string, nullable
            - `created_at` string, date-time, required
            - `currency` string, required
            - `customer_external_id` string, required
            - `default_payment_method_id` string, nullable
            - `discounts` BillingSubscriptionDiscountView[], required
              - …
            - `expired_at` string, date-time, nullable
            - `id` string, required
            - `interval` string, required
            - `latest_invoice` InvoiceResponseData
              - …
            - `metadata` object
            - `payment_method` PaymentMethodResponseData
              - …
            - `period_end` integer, required
            - `period_start` integer, required
            - `products` BillingProductForSubscriptionResponseData[], required
              - …
            - `provider_type` 'metronome' | 'orb' | 'schematic' | 'stripe', required
            - `status` string, required
            - `subscription_external_id` string, required
            - `total_price` integer, required
            - `trial_end` integer, nullable
            - `trial_end_setting` 'cancel' | 'subscribe'
          - `created_at` string, date-time, required
          - `custom_plan_billings` CustomPlanBillingResponseData[], required
            - `activation_strategy` 'on_payment' | 'on_publish', required
            - `billing_cycle_anchor` string, date-time, nullable — The billing period renewal date pinned when the subscription started, when one was set. When no invoice exists yet, the first invoice is raised on this date.
            - `company_id` string, required
            - `created_at` string, date-time, required
            - `days_until_due` integer, required
            - `external_invoice_id` string, nullable
            - `id` string, required
            - `paid_at` string, date-time, nullable
            - `plan_billing_source` 'custom_plan' | 'manage_plan', required
            - `plan_id` string, required
            - `published_at` string, date-time, nullable
            - `send_invoice` boolean, required
            - `status` 'active' | 'expired' | 'paid' | 'pending', required
            - `stripe_invoice_url` string, nullable
            - `updated_at` string, date-time, required
          - `default_payment_method` PaymentMethodResponseData
            - `account_last4` string, nullable
            - `account_name` string, nullable
            - `bank_name` string, nullable
            - `billing_email` string, nullable
            - `billing_name` string, nullable
            - `card_brand` string, nullable
            - `card_exp_month` integer, nullable
            - `card_exp_year` integer, nullable
            - `card_last4` string, nullable
            - `company_id` string, nullable
            - `created_at` string, date-time, required
            - `customer_external_id` string, required
            - `environment_id` string, required
            - `external_id` string, required
            - `id` string, required
            - `payment_method_type` string, required
            - `provider_type` 'metronome' | 'orb' | 'schematic' | 'stripe', required
            - `updated_at` string, date-time, required
          - `entitlements` FeatureEntitlement[], required
            - `allocation` integer, nullable — If the company has a numeric entitlement for this feature, the allocated amount
            - `consumption_rate` number, double, nullable — If the company has a credit-based entitlement for this feature, the credit cost per unit of usage
            - `credit_id` string, nullable — If the company has a credit-based entitlement for this feature, the ID of the credit
            - `credit_remaining` number, double, nullable — If the company has a credit-based entitlement for this feature, the credit available to fund new consumption or a new lease hold — open lease holds are excluded. Clients that hold a lease should gate on this plus their own unspent hold; clients with no lease awareness should use credit_settled instead
            - `credit_reserved` number, double, nullable — If the company has a credit-based entitlement for this feature, the unspent amount held by an open credit lease. Returns to credit_remaining when the lease is released
            - `credit_settled` number, double, nullable — If the company has a credit-based entitlement for this feature, the balance net of actual consumption, unaffected by open lease holds (credit_remaining plus credit_reserved). The number to display to end users
            - `credit_total` number, double, nullable — If the company has a credit-based entitlement for this feature, the total credit amount
            - `credit_used` number, double, nullable — If the company has a credit-based entitlement for this feature, the amount of credit used
            - `event_name` string, nullable — If the feature is event-based, the name of the event tracked for usage
            - `event_subtype` string, nullable — For event-based or credit-metered feature entitlements, the event subtype whose usage is tracked
            - `feature_id` string, required — The ID of the feature
            - `feature_key` string, required — The key of the flag associated with the feature
            - `metric_period` 'all_time' | 'current_day' | 'current_month' | 'current_week'
            - `metric_reset_at` string, date-time, nullable — For event-based feature entitlements, when the usage period will reset
            - `month_reset` 'billing_cycle' | 'first_of_month'
            - `soft_limit` integer, nullable — For usage-based pricing, the soft limit for overage charges or the next tier boundary
            - `usage` integer, nullable — If the company has a numeric entitlement for this feature, the current usage amount
            - `value_type` 'boolean' | 'credit' | 'numeric' | 'trait' | 'unknown' | 'unlimited', required
            - `warning_tiers` WarningTier[] — Customer-defined usage warning thresholds configured on this entitlement
              - …
          - `entity_traits` EntityTraitDetailResponseData[], required
            - `created_at` string, date-time, required
            - `definition` EntityTraitDefinitionResponseData
              - …
            - `definition_id` string, required
            - `environment_id` string, required
            - `id` string, required
            - `updated_at` string, date-time, required
            - `value` string, required
          - `environment_id` string, required
          - `id` string, required
          - `keys` EntityKeyDetailResponseData[], required
            - `created_at` string, date-time, required
            - `definition` EntityKeyDefinitionResponseData
              - …
            - `definition_id` string, required
            - `entity_id` string, required
            - `entity_type` 'company' | 'user', required
            - `environment_id` string, required
            - `id` string, required
            - `key` string, required
            - `updated_at` string, date-time, required
            - `value` string, required
          - `last_seen_at` string, date-time, nullable
          - `logo_url` string, nullable
          - `metrics` CompanyEventPeriodMetricsResponseData[], required
            - `account_id` string, required
            - `captured_at_max` string, date-time, required
            - `captured_at_min` string, date-time, required
            - `company_id` string, required
            - `created_at` string, date-time, required
            - `environment_id` string, required
            - `event_subtype` string, required
            - `month_reset` 'billing_cycle' | 'first_of_month', required
            - `period` 'all_time' | 'current_day' | 'current_month' | 'current_week', required
            - `valid_until` string, date-time, nullable
            - `value` integer, required
          - `name` string, required
          - `payment_methods` PaymentMethodResponseData[], required
            - `account_last4` string, nullable
            - `account_name` string, nullable
            - `bank_name` string, nullable
            - `billing_email` string, nullable
            - `billing_name` string, nullable
            - `card_brand` string, nullable
            - `card_exp_month` integer, nullable
            - `card_exp_year` integer, nullable
            - `card_last4` string, nullable
            - `company_id` string, nullable
            - `created_at` string, date-time, required
            - `customer_external_id` string, required
            - `environment_id` string, required
            - `external_id` string, required
            - `id` string, required
            - `payment_method_type` string, required
            - `provider_type` 'metronome' | 'orb' | 'schematic' | 'stripe', required
            - `updated_at` string, date-time, required
          - `plan` CompanyPlanWithBillingSubView
            - `added_on` string, date-time, nullable
            - `billing_product_external_id` string, nullable
            - `billing_product_id` string, nullable
            - `description` string, nullable
            - `id` string, required
            - `image_url` string, nullable
            - `included_credit_grants` CompanyPlanCreditGrantView[], required
              - …
            - `name` string, required
            - `plan_period` string, nullable
            - `plan_price` integer, nullable
            - `plan_version_id` string, nullable
          - `plans` GenericPreviewObject[], required
            - `description` string, nullable
            - `id` string, required
            - `image_url` string, nullable
            - `name` string, required
          - `rules` Rule[], required
            - `account_id` string, required
            - `condition_groups` ConditionGroup[], required
              - …
            - `conditions` Condition[], required
              - …
            - `environment_id` string, required
            - `flag_id` string, nullable
            - `id` string, required
            - `name` string, required
            - `priority` integer, required
            - `rule_type` 'company_override' | 'company_override_usage_exceeded' | 'default' | 'global_override' | 'plan_entitlement' | 'plan_entitlement_usage_exceeded' | 'standard', required
            - `value` boolean, required
          - `scheduled_downgrade` ScheduledDowngradeResponseData
            - `currency` string, required
            - `effective_after` string, date-time, required
            - `from_plan_id` string, required
            - `from_plan_name` string, required
            - `from_subscription_price` integer, required
            - `id` string, required
            - `interval` string, required
            - `scheduled_interval` string, nullable
            - `scheduled_price` integer, nullable
            - `to_plan_id` string, required
            - `to_plan_name` string, required
          - `traits` object — A map of trait names to trait values
          - `updated_at` string, date-time, required
          - `user_count` integer, required
        - `company_id` string, required
        - `consumption_rate` number, double, nullable
        - `created_at` string, date-time, required
        - `environment_id` string, required
        - `expiration_date` string, date-time, nullable
        - `feature` FeatureResponseData
          - `created_at` string, date-time, required
          - `description` string, required
          - `event_subtype` string, nullable
          - `feature_type` 'boolean' | 'event' | 'license' | 'trait', required
          - `icon` string, required
          - `id` string, required
          - `license_id` string, nullable — The license sold through this feature. Set only on features of type license, and created automatically with them.
          - `lifecycle_phase` 'add_on' | 'alpha' | 'beta' | 'deprecated' | 'ga' | 'inactive' | 'in_plan' | 'internal_testing' | 'legacy'
          - `maintainer_account_member_id` string, nullable
          - `name` string, required
          - `plural_name` string, nullable
          - `singular_name` string, nullable
          - `trait_id` string, nullable
          - `updated_at` string, date-time, required
          - `usage_limit_trait_id` string, nullable — Set when the feature carries a pay-in-advance quantity. Provisioned lazily for other feature types, and at creation for license features.
        - `feature_id` string, required
        - `id` string, required
        - `metric_period` 'all_time' | 'current_day' | 'current_month' | 'current_week'
        - `metric_period_month_reset` 'billing_cycle' | 'first_of_month'
        - `notes` CompanyOverrideNoteResponseData[], required
          - `created_at` string, date-time, required
          - `external_user_id` string, required
          - `external_user_name` string, required
          - `id` string, required
          - `note` string, required
          - `updated_at` string, date-time, required
        - `rule_id` string, nullable
        - `rule_id_usage_exceeded` string, nullable
        - `updated_at` string, date-time, required
        - `value_bool` boolean, nullable
        - `value_numeric` integer, nullable
        - `value_trait` EntityTraitDefinitionResponseData
          - `created_at` string, date-time, required
          - `display_name` string, required
          - `entity_type` 'company' | 'user', required
          - `hierarchy` string[], required
          - `id` string, required
          - `trait_type` 'boolean' | 'currency' | 'date' | 'number' | 'string' | 'url', required
          - `updated_at` string, date-time, required
        - `value_trait_id` string, nullable
        - `value_type` 'boolean' | 'credit' | 'numeric' | 'trait' | 'unknown' | 'unlimited', required
      - `credit_consumption_rate` number, double, nullable — The rate at which credits are consumed per unit of usage
      - `credit_grant_counts` object
      - `credit_grant_details` CreditGrantDetail[]
        - `credit_type_icon` string, nullable
        - `expires_at` string, date-time, nullable
        - `grant_reason` 'adjustment' | 'billing_credit_auto_topup' | 'free' | 'plan' | 'purchased' | 'rollover', required
        - `quantity` number, double, required
      - `credit_grant_reason` 'adjustment' | 'billing_credit_auto_topup' | 'free' | 'plan' | 'purchased' | 'rollover'
      - `credit_remaining` number, double, nullable
      - `credit_total` number, double, nullable — Deprecated: Use credit_remaining instead.
      - `credit_type_icon` string, nullable — Icon identifier for the credit type
      - `credit_usage_aggregation` CreditUsageAggregation
        - `usage_this_billing_period` number, double, nullable — Credit usage within the current billing period
        - `usage_this_calendar_month` number, double, nullable — Credit usage within the current calendar month
        - `usage_this_week` number, double, nullable — Credit usage within the current calendar week (Monday to Sunday)
        - `usage_today` number, double, nullable — Credit usage for the current day
      - `credit_used` number, double, nullable
      - `effective_limit` integer, nullable — Effective limit for usage calculations. For overage pricing, this is the soft limit where overage charges begin. For tiered pricing, this is the first tier boundary. For other pricing models, this is the base allocation. Used to calculate usage percentages and determine access thresholds.
      - `effective_price` number, double, nullable — Per-unit price for current usage scenario
      - `entitlement_expiration_date` string, date-time, nullable
      - `entitlement_id` string, required
      - `entitlement_source` string, nullable — Source of the entitlement (plan or company_override)
      - `entitlement_type` 'company_override' | 'plan_entitlement' | 'unknown', required
      - `feature` FeatureInPlanResponseData
        - `billing_linked_resource` BillingLinkedResourceResponseData
          - `billing_provider` 'metronome' | 'orb' | 'schematic' | 'stripe', required
          - `external_resource_id` string, required
          - `originator` 'metronome' | 'orb' | 'schematic' | 'stripe', required
        - `created_at` string, date-time, required
        - `description` string, required
        - `event_subtype` string, nullable
        - `event_summary` EventSummaryResponseData
          - `company_count` integer, required
          - `environment_id` string, required
          - `event_count` integer, required
          - `event_subtype` string, required
          - `last_seen_at` string, date-time, nullable
          - `user_count` integer, required
        - `feature_type` 'boolean' | 'event' | 'license' | 'trait', required
        - `flags` FlagInPlanResponseData[], required
          - `created_at` string, date-time, required
          - `default_value` boolean, required
          - `description` string, required
          - `feature` FeatureResponseData
            - `created_at` string, date-time, required
            - `description` string, required
            - `event_subtype` string, nullable
            - `feature_type` 'boolean' | 'event' | 'license' | 'trait', required
            - `icon` string, required
            - `id` string, required
            - `license_id` string, nullable — The license sold through this feature. Set only on features of type license, and created automatically with them.
            - `lifecycle_phase` 'add_on' | 'alpha' | 'beta' | 'deprecated' | 'ga' | 'inactive' | 'in_plan' | 'internal_testing' | 'legacy'
            - `maintainer_account_member_id` string, nullable
            - `name` string, required
            - `plural_name` string, nullable
            - `singular_name` string, nullable
            - `trait_id` string, nullable
            - `updated_at` string, date-time, required
            - `usage_limit_trait_id` string, nullable — Set when the feature carries a pay-in-advance quantity. Provisioned lazily for other feature types, and at creation for license features.
          - `feature_id` string, nullable
          - `flag_type` 'boolean', required
          - `id` string, required
          - `key` string, required
          - `last_checked_at` string, date-time, nullable
          - `maintainer_account_member_id` string, nullable
          - `name` string, required
          - `rules` RuleDetailResponseData[], required
            - `condition_groups` RuleConditionGroupDetailResponseData[], required
              - …
            - `conditions` RuleConditionDetailResponseData[], required
              - …
            - `created_at` string, date-time, required
            - `environment_id` string, required
            - `flag_id` string, nullable
            - `id` string, required
            - `name` string, required
            - `priority` integer, required
            - `rule_type` 'company_override' | 'company_override_usage_exceeded' | 'default' | 'global_override' | 'plan_entitlement' | 'plan_entitlement_usage_exceeded' | 'standard', required
            - `updated_at` string, date-time, required
            - `value` boolean, required
          - `updated_at` string, date-time, required
        - `icon` string, required
        - `id` string, required
        - `license_id` string, nullable — The license sold through this feature. Set only on features of type license, and created automatically with them.
        - `lifecycle_phase` 'add_on' | 'alpha' | 'beta' | 'deprecated' | 'ga' | 'inactive' | 'in_plan' | 'internal_testing' | 'legacy'
        - `maintainer_account_member_id` string, nullable
        - `name` string, required
        - `plans` PreviewObject[], required
          - `description` string, nullable
          - `id` string, required
          - `image_url` string, nullable
          - `name` string, required
        - `plural_name` string, nullable
        - `singular_name` string, nullable
        - `trait` EntityTraitDefinitionResponseData
          - `created_at` string, date-time, required
          - `display_name` string, required
          - `entity_type` 'company' | 'user', required
          - `hierarchy` string[], required
          - `id` string, required
          - `trait_type` 'boolean' | 'currency' | 'date' | 'number' | 'string' | 'url', required
          - `updated_at` string, date-time, required
        - `trait_id` string, nullable
        - `updated_at` string, date-time, required
        - `usage_limit_trait_id` string, nullable — Set when the feature carries a pay-in-advance quantity. Provisioned lazily for other feature types, and at creation for license features.
      - `has_valid_allocation` boolean, nullable — Whether a valid allocation exists
      - `is_unlimited` boolean, nullable — Whether this is an unlimited allocation
      - `metric_reset_at` string, date-time, nullable — The time at which the metric will reset.
      - `month_reset` 'billing_cycle' | 'first_of_month'
      - `monthly_usage_based_price` BillingPriceView
        - `billing_scheme` 'per_unit' | 'tiered', required
        - `created_at` string, date-time, required
        - `currency` string, required
        - `id` string, required
        - `interval` 'day' | 'month' | 'one-time' | 'year', required
        - `interval_count` integer, required
        - `is_active` boolean, required
        - `meter_event_name` string, nullable
        - `meter_event_payload_key` string, nullable
        - `meter_id` string, nullable
        - `nickname` string, nullable
        - `package_size` integer, required
        - `price` integer, required
        - `price_decimal` string, nullable
        - `price_external_id` string, required
        - `price_id` string, required
        - `price_tier` BillingProductPriceTierResponseData[], required
          - `flat_amount` integer, nullable
          - `per_unit_price` integer, nullable
          - `per_unit_price_decimal` string, nullable
          - `up_to` integer, nullable
        - `product_external_id` string, required
        - `product_id` string, required
        - `product_name` string, required
        - `provider_type` 'metronome' | 'orb' | 'schematic' | 'stripe', required
        - `tiers_mode` 'graduated' | 'volume'
        - `updated_at` string, date-time, required
        - `usage_type` 'licensed' | 'metered', required
      - `overuse` integer, nullable — Amount of usage exceeding soft limit (overage pricing only)
      - `percent_used` number, double, nullable — Percentage of allocation consumed (0-100+)
      - `period` 'all_time' | 'current_day' | 'current_month' | 'current_week'
      - `plan` PlanResponseData
        - `audience_type` string, nullable
        - `company_id` string, nullable
        - `copied_from_plan_id` string, nullable
        - `created_at` string, date-time, required
        - `description` string, required
        - `icon` 'amber' | 'blue' | 'blueGray' | 'blueGreen' | 'cyan' | 'emerald' | 'fuchsia' | 'gray' | 'green' | 'indigo' | 'lightBlue' | 'lime' | 'orange' | 'pink' | 'purple' | 'red' | 'redOrange' | 'rose' | 'sky' | 'slate' | 'teal' | 'trueGray' | 'violet' | 'warmGray' | 'yellow', required
        - `id` string, required
        - `name` string, required
        - `plan_type` 'plan' | 'add_on', required
        - `updated_at` string, date-time, required
      - `plan_entitlement` PlanEntitlementResponseData
        - `billing_linked_resource` BillingLinkedResourceResponseData
          - `billing_provider` 'metronome' | 'orb' | 'schematic' | 'stripe', required
          - `external_resource_id` string, required
          - `originator` 'metronome' | 'orb' | 'schematic' | 'stripe', required
        - `billing_threshold` integer, nullable
        - `consumption_rate` number, double, nullable
        - `created_at` string, date-time, required
        - `currency_prices` EntitlementCurrencyPricesResponseData[], required
          - `currency` string, required
          - `monthly_price` BillingPriceView
            - `billing_scheme` 'per_unit' | 'tiered', required
            - `created_at` string, date-time, required
            - `currency` string, required
            - `id` string, required
            - `interval` 'day' | 'month' | 'one-time' | 'year', required
            - `interval_count` integer, required
            - `is_active` boolean, required
            - `meter_event_name` string, nullable
            - `meter_event_payload_key` string, nullable
            - `meter_id` string, nullable
            - `nickname` string, nullable
            - `package_size` integer, required
            - `price` integer, required
            - `price_decimal` string, nullable
            - `price_external_id` string, required
            - `price_id` string, required
            - `price_tier` BillingProductPriceTierResponseData[], required
              - …
            - `product_external_id` string, required
            - `product_id` string, required
            - `product_name` string, required
            - `provider_type` 'metronome' | 'orb' | 'schematic' | 'stripe', required
            - `tiers_mode` 'graduated' | 'volume'
            - `updated_at` string, date-time, required
            - `usage_type` 'licensed' | 'metered', required
          - `quarterly_price` BillingPriceView
            - `billing_scheme` 'per_unit' | 'tiered', required
            - `created_at` string, date-time, required
            - `currency` string, required
            - `id` string, required
            - `interval` 'day' | 'month' | 'one-time' | 'year', required
            - `interval_count` integer, required
            - `is_active` boolean, required
            - `meter_event_name` string, nullable
            - `meter_event_payload_key` string, nullable
            - `meter_id` string, nullable
            - `nickname` string, nullable
            - `package_size` integer, required
            - `price` integer, required
            - `price_decimal` string, nullable
            - `price_external_id` string, required
            - `price_id` string, required
            - `price_tier` BillingProductPriceTierResponseData[], required
              - …
            - `product_external_id` string, required
            - `product_id` string, required
            - `product_name` string, required
            - `provider_type` 'metronome' | 'orb' | 'schematic' | 'stripe', required
            - `tiers_mode` 'graduated' | 'volume'
            - `updated_at` string, date-time, required
            - `usage_type` 'licensed' | 'metered', required
          - `yearly_price` BillingPriceView
            - `billing_scheme` 'per_unit' | 'tiered', required
            - `created_at` string, date-time, required
            - `currency` string, required
            - `id` string, required
            - `interval` 'day' | 'month' | 'one-time' | 'year', required
            - `interval_count` integer, required
            - `is_active` boolean, required
            - `meter_event_name` string, nullable
            - `meter_event_payload_key` string, nullable
            - `meter_id` string, nullable
            - `nickname` string, nullable
            - `package_size` integer, required
            - `price` integer, required
            - `price_decimal` string, nullable
            - `price_external_id` string, required
            - `price_id` string, required
            - `price_tier` BillingProductPriceTierResponseData[], required
              - …
            - `product_external_id` string, required
            - `product_id` string, required
            - `product_name` string, required
            - `provider_type` 'metronome' | 'orb' | 'schematic' | 'stripe', required
            - `tiers_mode` 'graduated' | 'volume'
            - `updated_at` string, date-time, required
            - `usage_type` 'licensed' | 'metered', required
        - `environment_id` string, required
        - `feature` FeatureResponseData
          - `created_at` string, date-time, required
          - `description` string, required
          - `event_subtype` string, nullable
          - `feature_type` 'boolean' | 'event' | 'license' | 'trait', required
          - `icon` string, required
          - `id` string, required
          - `license_id` string, nullable — The license sold through this feature. Set only on features of type license, and created automatically with them.
          - `lifecycle_phase` 'add_on' | 'alpha' | 'beta' | 'deprecated' | 'ga' | 'inactive' | 'in_plan' | 'internal_testing' | 'legacy'
          - `maintainer_account_member_id` string, nullable
          - `name` string, required
          - `plural_name` string, nullable
          - `singular_name` string, nullable
          - `trait_id` string, nullable
          - `updated_at` string, date-time, required
          - `usage_limit_trait_id` string, nullable — Set when the feature carries a pay-in-advance quantity. Provisioned lazily for other feature types, and at creation for license features.
        - `feature_id` string, required
        - `id` string, required
        - `metered_monthly_price` BillingPriceView
          - `billing_scheme` 'per_unit' | 'tiered', required
          - `created_at` string, date-time, required
          - `currency` string, required
          - `id` string, required
          - `interval` 'day' | 'month' | 'one-time' | 'year', required
          - `interval_count` integer, required
          - `is_active` boolean, required
          - `meter_event_name` string, nullable
          - `meter_event_payload_key` string, nullable
          - `meter_id` string, nullable
          - `nickname` string, nullable
          - `package_size` integer, required
          - `price` integer, required
          - `price_decimal` string, nullable
          - `price_external_id` string, required
          - `price_id` string, required
          - `price_tier` BillingProductPriceTierResponseData[], required
            - `flat_amount` integer, nullable
            - `per_unit_price` integer, nullable
            - `per_unit_price_decimal` string, nullable
            - `up_to` integer, nullable
          - `product_external_id` string, required
          - `product_id` string, required
          - `product_name` string, required
          - `provider_type` 'metronome' | 'orb' | 'schematic' | 'stripe', required
          - `tiers_mode` 'graduated' | 'volume'
          - `updated_at` string, date-time, required
          - `usage_type` 'licensed' | 'metered', required
        - `metered_quarterly_price` BillingPriceView
          - `billing_scheme` 'per_unit' | 'tiered', required
          - `created_at` string, date-time, required
          - `currency` string, required
          - `id` string, required
          - `interval` 'day' | 'month' | 'one-time' | 'year', required
          - `interval_count` integer, required
          - `is_active` boolean, required
          - `meter_event_name` string, nullable
          - `meter_event_payload_key` string, nullable
          - `meter_id` string, nullable
          - `nickname` string, nullable
          - `package_size` integer, required
          - `price` integer, required
          - `price_decimal` string, nullable
          - `price_external_id` string, required
          - `price_id` string, required
          - `price_tier` BillingProductPriceTierResponseData[], required
            - `flat_amount` integer, nullable
            - `per_unit_price` integer, nullable
            - `per_unit_price_decimal` string, nullable
            - `up_to` integer, nullable
          - `product_external_id` string, required
          - `product_id` string, required
          - `product_name` string, required
          - `provider_type` 'metronome' | 'orb' | 'schematic' | 'stripe', required
          - `tiers_mode` 'graduated' | 'volume'
          - `updated_at` string, date-time, required
          - `usage_type` 'licensed' | 'metered', required
        - `metered_yearly_price` BillingPriceView
          - `billing_scheme` 'per_unit' | 'tiered', required
          - `created_at` string, date-time, required
          - `currency` string, required
          - `id` string, required
          - `interval` 'day' | 'month' | 'one-time' | 'year', required
          - `interval_count` integer, required
          - `is_active` boolean, required
          - `meter_event_name` string, nullable
          - `meter_event_payload_key` string, nullable
          - `meter_id` string, nullable
          - `nickname` string, nullable
          - `package_size` integer, required
          - `price` integer, required
          - `price_decimal` string, nullable
          - `price_external_id` string, required
          - `price_id` string, required
          - `price_tier` BillingProductPriceTierResponseData[], required
            - `flat_amount` integer, nullable
            - `per_unit_price` integer, nullable
            - `per_unit_price_decimal` string, nullable
            - `up_to` integer, nullable
          - `product_external_id` string, required
          - `product_id` string, required
          - `product_name` string, required
          - `provider_type` 'metronome' | 'orb' | 'schematic' | 'stripe', required
          - `tiers_mode` 'graduated' | 'volume'
          - `updated_at` string, date-time, required
          - `usage_type` 'licensed' | 'metered', required
        - `metric_period` 'all_time' | 'current_day' | 'current_month' | 'current_week'
        - `metric_period_month_reset` 'billing_cycle' | 'first_of_month'
        - `plan` PlanResponseData
          - `audience_type` string, nullable
          - `company_id` string, nullable
          - `copied_from_plan_id` string, nullable
          - `created_at` string, date-time, required
          - `description` string, required
          - `icon` 'amber' | 'blue' | 'blueGray' | 'blueGreen' | 'cyan' | 'emerald' | 'fuchsia' | 'gray' | 'green' | 'indigo' | 'lightBlue' | 'lime' | 'orange' | 'pink' | 'purple' | 'red' | 'redOrange' | 'rose' | 'sky' | 'slate' | 'teal' | 'trueGray' | 'violet' | 'warmGray' | 'yellow', required
          - `id` string, required
          - `name` string, required
          - `plan_type` 'plan' | 'add_on', required
          - `updated_at` string, date-time, required
        - `plan_id` string, required
        - `price_behavior` 'credit_burndown' | 'overage' | 'pay_as_you_go' | 'pay_in_advance' | 'tier'
        - `rule_id` string, required
        - `rule_id_usage_exceeded` string, nullable
        - `soft_limit` integer, nullable
        - `updated_at` string, date-time, required
        - `usage_based_product` BillingProductResponseData
          - `account_id` string, required
          - `created_at` string, date-time, required
          - `currency` string, nullable — Deprecated; currencies are associated with prices, not products
          - `environment_id` string, required
          - `external_id` string, required
          - `is_active` boolean, required
          - `name` string, required
          - `price` number, double, required
          - `price_decimal` string, nullable
          - `product_id` string, required
          - `provider_type` 'metronome' | 'orb' | 'schematic' | 'stripe', required
          - `quantity` number, double, required
          - `updated_at` string, date-time, required
        - `usage_quantity` integer, nullable — The committed unit quantity for this entitlement. For custom plans this is the quantity the company is contractually committed to; for standard plans it is the quantity pre-filled when subscribing. Only applies to pay-in-advance entitlements. Note: this is not yet enforced/auto-provisioned as a true default — it is currently stored for downstream billing use.
        - `value_bool` boolean, nullable
        - `value_credit` BillingCreditResponseData
          - `burn_strategy` 'expiration_priority' | 'first_in_first_out' | 'last_in_first_out' | 'plan_first_then_credit_bundles_first_in_first_out', required
          - `cost_editable` boolean, required
          - `created_at` string, date-time, required
          - `currency_prices` CreditCurrencyPriceResponseData[], required
            - `currency` string, required
            - `price` BillingPriceResponseData
              - …
          - `default_expiry_unit` 'billing_periods' | 'days', required
          - `default_expiry_unit_count` integer, nullable
          - `default_rollover_policy` 'expire' | 'none' | 'rollover', required
          - `description` string, required
          - `icon` string, nullable
          - `id` string, required
          - `name` string, required
          - `plural_name` string, nullable
          - `price` BillingPriceResponseData
            - `currency` string, required
            - `external_price_id` string, required
            - `id` string, required
            - `interval` 'day' | 'month' | 'one-time' | 'year', required
            - `interval_count` integer, required
            - `nickname` string, nullable
            - `price` integer, required
            - `price_decimal` string, nullable
            - `provider_type` 'metronome' | 'orb' | 'schematic' | 'stripe', required
            - `scheme` 'per_unit' | 'tiered', required
          - `product` BillingProductResponseData
            - `account_id` string, required
            - `created_at` string, date-time, required
            - `currency` string, nullable — Deprecated; currencies are associated with prices, not products
            - `environment_id` string, required
            - `external_id` string, required
            - `is_active` boolean, required
            - `name` string, required
            - `price` number, double, required
            - `price_decimal` string, nullable
            - `product_id` string, required
            - `provider_type` 'metronome' | 'orb' | 'schematic' | 'stripe', required
            - `quantity` number, double, required
            - `updated_at` string, date-time, required
          - `singular_name` string, nullable
          - `updated_at` string, date-time, required
        - `value_numeric` integer, nullable
        - `value_trait` EntityTraitDefinitionResponseData
          - `created_at` string, date-time, required
          - `display_name` string, required
          - `entity_type` 'company' | 'user', required
          - `hierarchy` string[], required
          - `id` string, required
          - `trait_type` 'boolean' | 'currency' | 'date' | 'number' | 'string' | 'url', required
          - `updated_at` string, date-time, required
        - `value_trait_id` string, nullable
        - `value_type` 'boolean' | 'credit' | 'numeric' | 'trait' | 'unknown' | 'unlimited', required
        - `warning_tiers` WarningTierResponseData[], required
          - `id` string, required
          - `key` string, required
          - `value` integer, required
      - `price_behavior` 'credit_burndown' | 'overage' | 'pay_as_you_go' | 'pay_in_advance' | 'tier'
      - `quarterly_usage_based_price` BillingPriceView
        - `billing_scheme` 'per_unit' | 'tiered', required
        - `created_at` string, date-time, required
        - `currency` string, required
        - `id` string, required
        - `interval` 'day' | 'month' | 'one-time' | 'year', required
        - `interval_count` integer, required
        - `is_active` boolean, required
        - `meter_event_name` string, nullable
        - `meter_event_payload_key` string, nullable
        - `meter_id` string, nullable
        - `nickname` string, nullable
        - `package_size` integer, required
        - `price` integer, required
        - `price_decimal` string, nullable
        - `price_external_id` string, required
        - `price_id` string, required
        - `price_tier` BillingProductPriceTierResponseData[], required
          - `flat_amount` integer, nullable
          - `per_unit_price` integer, nullable
          - `per_unit_price_decimal` string, nullable
          - `up_to` integer, nullable
        - `product_external_id` string, required
        - `product_id` string, required
        - `product_name` string, required
        - `provider_type` 'metronome' | 'orb' | 'schematic' | 'stripe', required
        - `tiers_mode` 'graduated' | 'volume'
        - `updated_at` string, date-time, required
        - `usage_type` 'licensed' | 'metered', required
      - `soft_limit` integer, nullable — The soft limit for the feature usage. Available only for overage price behavior
      - `usage` integer, nullable — The amount of usage that has been consumed; a null value indicates that usage is not being measured or that this is a credit-based entitlement (use credit_used instead).
      - `yearly_usage_based_price` BillingPriceView
        - `billing_scheme` 'per_unit' | 'tiered', required
        - `created_at` string, date-time, required
        - `currency` string, required
        - `id` string, required
        - `interval` 'day' | 'month' | 'one-time' | 'year', required
        - `interval_count` integer, required
        - `is_active` boolean, required
        - `meter_event_name` string, nullable
        - `meter_event_payload_key` string, nullable
        - `meter_id` string, nullable
        - `nickname` string, nullable
        - `package_size` integer, required
        - `price` integer, required
        - `price_decimal` string, nullable
        - `price_external_id` string, required
        - `price_id` string, required
        - `price_tier` BillingProductPriceTierResponseData[], required
          - `flat_amount` integer, nullable
          - `per_unit_price` integer, nullable
          - `per_unit_price_decimal` string, nullable
          - `up_to` integer, nullable
        - `product_external_id` string, required
        - `product_id` string, required
        - `product_name` string, required
        - `provider_type` 'metronome' | 'orb' | 'schematic' | 'stripe', required
        - `tiers_mode` 'graduated' | 'volume'
        - `updated_at` string, date-time, required
        - `usage_type` 'licensed' | 'metered', required
  - `params` object, required — Input parameters
    - `keys` object

## Other responses

- `401` — Unauthorized
- `403` — Forbidden
- `404` — Not found
- `500` — Server error

---

[API](https://skmtc.net/schematichq/apis/schematic-api.md) · [All operations](https://skmtc.net/schematichq/apis/schematic-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/schematichq/schematic-api/revisions/776228e28d67/schema)