--- title: "Get checkout data" method: POST path: "/checkout-internal/data" tags: ["checkout"] --- # Get checkout data `POST /checkout-internal/data` ## Request body - CheckoutDataRequestBody - `company_id` string, required - `currency` string, nullable - `selected_plan_id` string, nullable ## Response `200` OK - object - `data` CheckoutDataResponseData, required - `active_add_ons` PlanDetailResponseData[], required - `active_version` PlanVersionResponseData - `created_at` string, date-time, required - `description` string, required - `environment_id` 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 - `original_plan_id` string, nullable - `plan_type` 'plan' | 'add_on', required - `status` 'published' | 'draft' | 'archived', required - `updated_at` string, date-time, required - `version` integer, required - `audience_type` string, nullable - `billing_linked_resource` BillingLinkedResourceResponseData - `billing_provider` 'metronome' | 'orb' | 'schematic' | 'stripe', required - `external_resource_id` string, required - `originator` 'metronome' | 'orb' | 'schematic' | 'stripe', required - `billing_product` BillingProductDetailResponseData - `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 - `prices` BillingPriceResponseData[], required - `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_id` string, required - `provider_type` 'metronome' | 'orb' | 'schematic' | 'stripe', required - `quantity` number, double, required - `subscription_count` integer, required - `updated_at` string, date-time, required - `billing_strategy` 'schematic_managed' | 'provider_managed' | 'no_billing', required - `catalogs` PlanCatalogMembershipResponseData[] - `id` string, required - `name` string, required - `charge_type` 'free' | 'none' | 'one_time' | 'recurring', required - `company_count` integer, required - `company_id` string, nullable - `company_logo_url` string, nullable - `company_name` string, nullable - `controlled_by` 'metronome' | 'orb' | 'schematic' | 'stripe', required - `copied_from_plan_id` string, nullable - `created_at` string, date-time, required - `credits` BillingCreditResponseData[], required - `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 - `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 - `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 - `currency_prices` PlanCurrencyPricesResponseData[], required - `currency` string, required - `monthly_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 - `one_time_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 - `quarterly_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 - `yearly_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 - `description` string, required - `draft_version` PlanVersionResponseData - `created_at` string, date-time, required - `description` string, required - `environment_id` 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 - `original_plan_id` string, nullable - `plan_type` 'plan' | 'add_on', required - `status` 'published' | 'draft' | 'archived', required - `updated_at` string, date-time, required - `version` integer, required - `entitlements` PlanEntitlementResponseData[], nullable - `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 - `features` FeatureInPlanResponseData[], required - `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. - `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 - `included_credit_grants` BillingPlanCreditGrantResponseData[] - `auto_topup_amount` integer, nullable - `auto_topup_amount_type` string, nullable - `auto_topup_availability` 'off' | 'automatic' | 'user_controlled', required - `auto_topup_enabled` boolean, required — Derived from auto_topup_availability; use that instead. - `auto_topup_expiry_type` 'duration' | 'end_of_billing_period' | 'end_of_next_billing_period' | 'end_of_trial' | 'no_expiry' - `auto_topup_expiry_unit` 'billing_periods' | 'days' - `auto_topup_expiry_unit_count` integer, nullable - `auto_topup_self_service` boolean, required — Derived from auto_topup_availability; use that instead. - `auto_topup_threshold_credits` integer, nullable - `auto_topup_threshold_percent` integer, nullable - `can_buy_bundles` boolean, required — Whether buyers can purchase one-time credit bundles on this grant, independent of auto top-up availability. - `created_at` string, date-time, required - `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 - `credit_amount` integer, required - `credit_id` string, required - `credit_name` string, required — Use credit.name from the nested credit object instead - `credit_plural_name` string, nullable — Use plural_name from the nested credit object instead - `credit_singular_name` string, nullable — Use singular_name from the nested credit object instead - `expiry_type` 'duration' | 'end_of_billing_period' | 'end_of_next_billing_period' | 'end_of_trial' | 'no_expiry' - `expiry_unit` 'billing_periods' | 'days' - `expiry_unit_count` integer, nullable - `id` string, required - `license_id` string, nullable — The license whose quantity scales this grant. Set only when scaling is per_license. - `plan` PreviewObjectResponseData - `description` string, nullable - `id` string, required - `image_url` string, nullable - `name` string, required - `plan_id` string, required - `plan_name` string, required — Use plan.name from the nested plan object instead - `plan_version_id` string, nullable - `reset_cadence` 'daily' | 'every_6_months' | 'monthly' | 'quarterly' | 'weekly' | 'yearly' - `reset_start` 'billing_period' | 'first_of_month' - `reset_type` 'no_reset' | 'plan_period' - `rollover_percentage` integer, required — Percentage of unused credits that carry over when this grant resets. Only meaningful when reset_type is plan_period. - `scaling` 'fixed' | 'per_license', required - `updated_at` string, date-time, required - `is_default` boolean, required - `is_free` boolean, nullable — Deprecated: reports the plan's charge type, not its price. Read the plan's prices to tell whether it costs anything, or billing_strategy to tell how it is billed. - `is_trialable` boolean, required - `monthly_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 - `name` string, required - `one_time_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 - `plan_type` 'plan' | 'add_on', required - `quarterly_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 - `trial_days` integer, nullable - `updated_at` string, date-time, required - `versions` PlanVersionResponseData[], required - `created_at` string, date-time, required - `description` string, required - `environment_id` 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 - `original_plan_id` string, nullable - `plan_type` 'plan' | 'add_on', required - `status` 'published' | 'draft' | 'archived', required - `updated_at` string, date-time, required - `version` integer, required - `yearly_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 - `active_plan` PlanDetailResponseData - `active_version` PlanVersionResponseData - `created_at` string, date-time, required - `description` string, required - `environment_id` 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 - `original_plan_id` string, nullable - `plan_type` 'plan' | 'add_on', required - `status` 'published' | 'draft' | 'archived', required - `updated_at` string, date-time, required - `version` integer, required - `audience_type` string, nullable - `billing_linked_resource` BillingLinkedResourceResponseData - `billing_provider` 'metronome' | 'orb' | 'schematic' | 'stripe', required - `external_resource_id` string, required - `originator` 'metronome' | 'orb' | 'schematic' | 'stripe', required - `billing_product` BillingProductDetailResponseData - `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 - `prices` BillingPriceResponseData[], required - `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_id` string, required - `provider_type` 'metronome' | 'orb' | 'schematic' | 'stripe', required - `quantity` number, double, required - `subscription_count` integer, required - `updated_at` string, date-time, required - `billing_strategy` 'schematic_managed' | 'provider_managed' | 'no_billing', required - `catalogs` PlanCatalogMembershipResponseData[] - `id` string, required - `name` string, required - `charge_type` 'free' | 'none' | 'one_time' | 'recurring', required - `company_count` integer, required - `company_id` string, nullable - `company_logo_url` string, nullable - `company_name` string, nullable - `controlled_by` 'metronome' | 'orb' | 'schematic' | 'stripe', required - `copied_from_plan_id` string, nullable - `created_at` string, date-time, required - `credits` BillingCreditResponseData[], required - `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 - `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 - `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 - `currency_prices` PlanCurrencyPricesResponseData[], required - `currency` string, required - `monthly_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 - `one_time_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 - `quarterly_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 - `yearly_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 - `description` string, required - `draft_version` PlanVersionResponseData - `created_at` string, date-time, required - `description` string, required - `environment_id` 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 - `original_plan_id` string, nullable - `plan_type` 'plan' | 'add_on', required - `status` 'published' | 'draft' | 'archived', required - `updated_at` string, date-time, required - `version` integer, required - `entitlements` PlanEntitlementResponseData[], nullable - `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 - `features` FeatureInPlanResponseData[], required - `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. - `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 - `included_credit_grants` BillingPlanCreditGrantResponseData[] - `auto_topup_amount` integer, nullable - `auto_topup_amount_type` string, nullable - `auto_topup_availability` 'off' | 'automatic' | 'user_controlled', required - `auto_topup_enabled` boolean, required — Derived from auto_topup_availability; use that instead. - `auto_topup_expiry_type` 'duration' | 'end_of_billing_period' | 'end_of_next_billing_period' | 'end_of_trial' | 'no_expiry' - `auto_topup_expiry_unit` 'billing_periods' | 'days' - `auto_topup_expiry_unit_count` integer, nullable - `auto_topup_self_service` boolean, required — Derived from auto_topup_availability; use that instead. - `auto_topup_threshold_credits` integer, nullable - `auto_topup_threshold_percent` integer, nullable - `can_buy_bundles` boolean, required — Whether buyers can purchase one-time credit bundles on this grant, independent of auto top-up availability. - `created_at` string, date-time, required - `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 - `credit_amount` integer, required - `credit_id` string, required - `credit_name` string, required — Use credit.name from the nested credit object instead - `credit_plural_name` string, nullable — Use plural_name from the nested credit object instead - `credit_singular_name` string, nullable — Use singular_name from the nested credit object instead - `expiry_type` 'duration' | 'end_of_billing_period' | 'end_of_next_billing_period' | 'end_of_trial' | 'no_expiry' - `expiry_unit` 'billing_periods' | 'days' - `expiry_unit_count` integer, nullable - `id` string, required - `license_id` string, nullable — The license whose quantity scales this grant. Set only when scaling is per_license. - `plan` PreviewObjectResponseData - `description` string, nullable - `id` string, required - `image_url` string, nullable - `name` string, required - `plan_id` string, required - `plan_name` string, required — Use plan.name from the nested plan object instead - `plan_version_id` string, nullable - `reset_cadence` 'daily' | 'every_6_months' | 'monthly' | 'quarterly' | 'weekly' | 'yearly' - `reset_start` 'billing_period' | 'first_of_month' - `reset_type` 'no_reset' | 'plan_period' - `rollover_percentage` integer, required — Percentage of unused credits that carry over when this grant resets. Only meaningful when reset_type is plan_period. - `scaling` 'fixed' | 'per_license', required - `updated_at` string, date-time, required - `is_default` boolean, required - `is_free` boolean, nullable — Deprecated: reports the plan's charge type, not its price. Read the plan's prices to tell whether it costs anything, or billing_strategy to tell how it is billed. - `is_trialable` boolean, required - `monthly_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 - `name` string, required - `one_time_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 - `plan_type` 'plan' | 'add_on', required - `quarterly_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 - `trial_days` integer, nullable - `updated_at` string, date-time, required - `versions` PlanVersionResponseData[], required - `created_at` string, date-time, required - `description` string, required - `environment_id` 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 - `original_plan_id` string, nullable - `plan_type` 'plan' | 'add_on', required - `status` 'published' | 'draft' | 'archived', required - `updated_at` string, date-time, required - `version` integer, required - `yearly_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 - `active_usage_based_entitlements` UsageBasedEntitlementResponseData[], required - `billing_threshold` integer, nullable - `consumption_rate` number, double, nullable - `feature_id` string, required - `metered_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' - `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 - `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 - `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_numeric` integer, nullable - `value_type` 'boolean' | 'credit' | 'numeric' | 'trait' | 'unknown' | 'unlimited', required - `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 - `available_credit_bundles` BillingCreditBundleResponseData[], required - `billing_invoice_id` string, nullable - `bundle_type` 'fixed', required - `created_at` string, date-time, required - `credit_description` string - `credit_icon` string, nullable - `credit_id` string, required - `credit_name` string, required - `currency_prices` CreditBundleCurrencyPriceResponseData[], required - `currency` string, required - `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 - `expiry_type` 'duration' | 'end_of_billing_period' | 'end_of_next_billing_period' | 'end_of_trial' | 'no_expiry', required - `expiry_unit` 'billing_periods' | 'days', required - `expiry_unit_count` integer, nullable - `has_grants` boolean, required - `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 - `quantity` integer, nullable - `singular_name` string, nullable - `status` 'active' | 'inactive', required - `unit_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 - `updated_at` string, date-time, required - `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 - `billing_credit_auto_topup_amount` integer, nullable - `billing_credit_auto_topup_amount_type` string, nullable - `billing_credit_auto_topup_availability` 'off' | 'automatic' | 'user_controlled' - `billing_credit_auto_topup_enabled` boolean, required - `billing_credit_auto_topup_expiry_type` 'duration' | 'end_of_billing_period' | 'end_of_next_billing_period' | 'end_of_trial' | 'no_expiry' - `billing_credit_auto_topup_expiry_unit` 'billing_periods' | 'days' - `billing_credit_auto_topup_expiry_unit_count` integer, nullable - `billing_credit_auto_topup_self_service` boolean, required - `billing_credit_auto_topup_threshold_credits` integer, nullable - `billing_credit_auto_topup_threshold_percent` integer, nullable - `billing_credit_can_buy_bundles` boolean, required - `company_auto_topup_amount` integer, nullable - `company_auto_topup_enabled` boolean, nullable - `company_auto_topup_threshold_credits` integer, nullable - `created_at` string, date-time, required - `credit` BillingCreditView - `account_id` string, required - `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` CreditCurrencyPrice[], required - … - `default_expiry_unit` 'billing_periods' | 'days', required - `default_expiry_unit_count` integer, nullable - `default_rollover_policy` 'expire' | 'none' | 'rollover', required - `description` string, required - `environment_id` string, required - `icon` string, nullable - `id` string, required - `ledger_authority` 'schematic_authoritative' | 'external_mirror' | 'external_rated', required - `name` string, required - `plural_name` string, nullable - `price` BillingPriceView - … - `price_per_unit` integer, nullable - `price_per_unit_decimal` string, nullable - `product` BillingProductRecordResponseData - … - `singular_name` string, nullable - `updated_at` string, date-time, required - `credit_amount` integer, required - `credit_description` string, required — Deprecated field, will be removed in the future. Use Credit.Description instead. - `credit_icon` string, nullable — Deprecated field, will be removed in the future. Use Credit.Icon instead. - `credit_id` string, required - `credit_name` string, required — Deprecated field, will be removed in the future. Use Credit.Name instead. - `expiry_type` 'duration' | 'end_of_billing_period' | 'end_of_next_billing_period' | 'end_of_trial' | 'no_expiry' - `expiry_unit` 'billing_periods' | 'days' - `expiry_unit_count` integer, nullable - `id` string, required - `license_id` string, nullable - `plan` GenericPreviewObject - `description` string, nullable - `id` string, required - `image_url` string, nullable - `name` string, required - `plan_id` string, required - `plan_version_id` string, nullable - `plural_name` string, nullable — Deprecated field, will be removed in the future. Use Credit.PluralName instead. - `reset_cadence` 'daily' | 'every_6_months' | 'monthly' | 'quarterly' | 'weekly' | 'yearly' - `reset_start` 'billing_period' | 'first_of_month' - `reset_type` 'no_reset' | 'plan_period', required - `rollover_percentage` integer, required - … truncated; see the full OpenAPI document linked below ## Other responses - `400` — Bad request - `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/versions/873fb318b08a/schema)