> If you are setting up, configuring, or answering questions about Schematic, connect the
> Schematic MCP server before working from these pages. It reads and writes plans, features,
> entitlements, and overrides against the real account, so what you report and what you build
> match what actually exists.
>
> The server is at https://api.schematichq.com/mcp
>
> From Claude, ChatGPT, or another chat assistant, add it as a custom connector:
> https://docs.schematichq.com/working-with-ai
>
> From a coding assistant such as Claude Code, Codex, or Cursor:
> https://docs.schematichq.com/building-with-ai
>
> For clean Markdown of any page, append `.md` to the page URL. For a complete page index,
> see https://docs.schematichq.com/llms.txt

# Update plan

PUT https://api.schematichq.com/plans/{plan_id}
Content-Type: application/json

Reference: https://docs.schematichq.com/api-reference/plans/update-plan

## Authentication

- `X-Schematic-Api-Key` header (required) — API Key authentication via header

## Request

### Path parameters

- `plan_id` (string, required) — plan_id

### Body (application/json)

This endpoint expects an UpdatePlanRequestBody.

- `name` (string, required)
- `description` (string, optional, nullable)
- `icon` (enum, optional, nullable)
  - Allowed values: `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`

## Response

### 200

OK

- `data` (PlanDetailResponseData, required)
- `params` (PlansPlanIdPutResponsesContentApplicationJsonSchemaParams, required) — Input parameters

## Errors

### 400 Bad Request Error

Bad request

- `error` (string, required) — Error message

### 401 Unauthorized Error

Unauthorized

- `error` (string, required) — Error message

### 403 Forbidden Error

Forbidden

- `error` (string, required) — Error message

### 404 Not Found Error

Not found

- `error` (string, required) — Error message

### 500 Internal Server Error

Server error

- `error` (string, required) — Error message

## Types

### PlanDetailResponseData

- `billing_strategy` (enum, required)
  - Allowed values: `schematic_managed`, `provider_managed`, `no_billing`
- `charge_type` (enum, required)
  - Allowed values: `free`, `none`, `one_time`, `recurring`
- `company_count` (long, required)
- `controlled_by` (enum, required)
  - Allowed values: `metronome`, `orb`, `schematic`, `stripe`
- `created_at` (datetime, required)
- `credits` (list of BillingCreditResponseData, required)
- `currency_prices` (list of PlanCurrencyPricesResponseData, required)
- `description` (string, required)
- `features` (list of FeatureInPlanResponseData, required)
- `icon` (enum, required)
  - Allowed values: `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`
- `id` (string, required)
- `is_trialable` (boolean, required)
- `name` (string, required)
- `plan_type` (enum, required)
  - Allowed values: `plan`, `add_on`
- `updated_at` (datetime, required)
- `versions` (list of PlanVersionResponseData, required)
- `is_default` (boolean, required, deprecated)
- `active_version` (PlanVersionResponseData, optional)
- `billing_linked_resource` (BillingLinkedResourceResponseData, optional)
- `billing_product` (BillingProductDetailResponseData, optional)
- `catalogs` (list of PlanCatalogMembershipResponseData, optional)
- `company_id` (string, optional, nullable)
- `company_logo_url` (string, optional, nullable)
- `company_name` (string, optional, nullable)
- `copied_from_plan_id` (string, optional, nullable)
- `draft_version` (PlanVersionResponseData, optional)
- `entitlements` (list of PlanEntitlementResponseData, optional, nullable)
- `included_credit_grants` (list of BillingPlanCreditGrantResponseData, optional)
- `monthly_price` (BillingPriceResponseData, optional)
- `one_time_price` (BillingPriceResponseData, optional)
- `quarterly_price` (BillingPriceResponseData, optional)
- `trial_days` (long, optional, nullable)
- `yearly_price` (BillingPriceResponseData, optional)
- `audience_type` (string, optional, nullable, deprecated)
- `is_free` (boolean, optional, nullable, deprecated) — 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.

### PlansPlanIdPutResponsesContentApplicationJsonSchemaParams

Input parameters

### BillingCreditResponseData

- `burn_strategy` (enum, required)
  - Allowed values: `expiration_priority`, `first_in_first_out`, `last_in_first_out`, `plan_first_then_credit_bundles_first_in_first_out`
- `cost_editable` (boolean, required)
- `created_at` (datetime, required)
- `currency_prices` (list of CreditCurrencyPriceResponseData, required)
- `default_expiry_unit` (enum, required)
  - Allowed values: `billing_periods`, `days`
- `default_rollover_policy` (enum, required)
  - Allowed values: `expire`, `none`, `rollover`
- `description` (string, required)
- `id` (string, required)
- `ledger_authority` (enum, required)
  - Allowed values: `schematic_authoritative`, `external_mirror`, `external_rated`
- `name` (string, required)
- `updated_at` (datetime, required)
- `default_expiry_unit_count` (long, optional, nullable)
- `icon` (string, optional, nullable)
- `plural_name` (string, optional, nullable)
- `price` (BillingPriceResponseData, optional)
- `product` (BillingProductResponseData, optional)
- `singular_name` (string, optional, nullable)

### PlanCurrencyPricesResponseData

- `currency` (string, required)
- `monthly_price` (BillingPriceResponseData, optional)
- `one_time_price` (BillingPriceResponseData, optional)
- `quarterly_price` (BillingPriceResponseData, optional)
- `yearly_price` (BillingPriceResponseData, optional)

### FeatureInPlanResponseData

- `created_at` (datetime, required)
- `description` (string, required)
- `feature_type` (enum, required)
  - Allowed values: `boolean`, `event`, `license`, `trait`
- `flags` (list of FlagInPlanResponseData, required)
- `icon` (string, required)
- `id` (string, required)
- `name` (string, required)
- `plans` (list of PreviewObject, required)
- `updated_at` (datetime, required)
- `billing_linked_resource` (BillingLinkedResourceResponseData, optional)
- `event_subtype` (string, optional, nullable)
- `event_summary` (EventSummaryResponseData, optional)
- `license_id` (string, optional, nullable) — The license sold through this feature. Set only on features of type license, and created automatically with them.
- `lifecycle_phase` (enum, optional, nullable)
  - Allowed values: `add_on`, `alpha`, `beta`, `deprecated`, `ga`, `inactive`, `in_plan`, `internal_testing`, `legacy`
- `maintainer_account_member_id` (string, optional, nullable)
- `plural_name` (string, optional, nullable)
- `singular_name` (string, optional, nullable)
- `trait` (EntityTraitDefinitionResponseData, optional)
- `trait_id` (string, optional, nullable)
- `usage_limit_trait_id` (string, optional, nullable) — Set when the feature carries a pay-in-advance quantity. Provisioned lazily for other feature types, and at creation for license features.

### PlanVersionResponseData

- `created_at` (datetime, required)
- `description` (string, required)
- `environment_id` (string, required)
- `icon` (enum, required)
  - Allowed values: `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`
- `id` (string, required)
- `name` (string, required)
- `plan_type` (enum, required)
  - Allowed values: `plan`, `add_on`
- `status` (enum, required)
  - Allowed values: `published`, `draft`, `archived`
- `updated_at` (datetime, required)
- `version` (long, required)
- `original_plan_id` (string, optional, nullable)

### BillingLinkedResourceResponseData

- `billing_provider` (enum, required)
  - Allowed values: `metronome`, `orb`, `schematic`, `stripe`
- `external_resource_id` (string, required)
- `originator` (enum, required)
  - Allowed values: `metronome`, `orb`, `schematic`, `stripe`

### BillingProductDetailResponseData

- `account_id` (string, required)
- `created_at` (datetime, required)
- `environment_id` (string, required)
- `external_id` (string, required)
- `is_active` (boolean, required)
- `name` (string, required)
- `price` (double, required)
- `prices` (list of BillingPriceResponseData, required)
- `product_id` (string, required)
- `provider_type` (enum, required)
  - Allowed values: `metronome`, `orb`, `schematic`, `stripe`
- `quantity` (double, required)
- `subscription_count` (long, required)
- `updated_at` (datetime, required)
- `price_decimal` (string, optional, nullable)
- `currency` (string, optional, nullable, deprecated) — Deprecated; currencies are associated with prices, not products

### PlanCatalogMembershipResponseData

- `id` (string, required)
- `name` (string, required)

### PlanEntitlementResponseData

- `created_at` (datetime, required)
- `currency_prices` (list of EntitlementCurrencyPricesResponseData, required)
- `environment_id` (string, required)
- `feature_id` (string, required)
- `id` (string, required)
- `plan_id` (string, required)
- `rule_id` (string, required)
- `updated_at` (datetime, required)
- `value_type` (enum, required)
  - Allowed values: `boolean`, `credit`, `numeric`, `trait`, `unknown`, `unlimited`
- `warning_tiers` (list of WarningTierResponseData, required)
- `billing_linked_resource` (BillingLinkedResourceResponseData, optional)
- `billing_threshold` (long, optional, nullable)
- `consumption_rate` (double, optional, nullable)
- `feature` (FeatureResponseData, optional)
- `metered_monthly_price` (BillingPriceView, optional)
- `metered_quarterly_price` (BillingPriceView, optional)
- `metered_yearly_price` (BillingPriceView, optional)
- `metric_period` (enum, optional, nullable)
  - Allowed values: `all_time`, `current_day`, `current_month`, `current_week`
- `metric_period_month_reset` (enum, optional, nullable)
  - Allowed values: `billing_cycle`, `first_of_month`
- `overage_billing_cadence` (enum, optional, nullable) — How often overage charges are assessed and invoiced. Null or end_of_billing_period means the billing provider aggregates usage over the subscription's own period and bills it at period end. Monthly and quarterly mean Schematic assesses the overage each month or quarter and bills it on its own invoice. Only applies to overage price behavior.
  - Allowed values: `end_of_billing_period`, `monthly`, `quarterly`
- `overage_invoice_anchor` (enum, optional, nullable) — Which boundary closes a monthly or quarterly overage window: the subscription's own recurrence (billing_period_start) or the calendar month (month_end), which for a quarterly window means calendar quarters. Only meaningful when overage_billing_cadence is monthly or quarterly.
  - Allowed values: `billing_period_start`, `month_end`
- `plan` (PlanResponseData, optional)
- `price_behavior` (enum, optional, nullable)
  - Allowed values: `credit_burndown`, `overage`, `pay_as_you_go`, `pay_in_advance`, `tier`
- `rule_id_usage_exceeded` (string, optional, nullable)
- `soft_limit` (long, optional, nullable)
- `usage_based_product` (BillingProductResponseData, optional)
- `usage_quantity` (long, optional, nullable) — The committed unit quantity for this entitlement. For custom plans this is the minimum the company is contractually committed to: the company can buy more, and finalizing a new plan version sets the subscription quantity to the larger of this value and what the subscription already holds. For standard plans it is the quantity pre-filled when subscribing. Only applies to pay-in-advance entitlements.
- `value_bool` (boolean, optional, nullable)
- `value_credit` (BillingCreditResponseData, optional)
- `value_numeric` (long, optional, nullable)
- `value_trait` (EntityTraitDefinitionResponseData, optional)
- `value_trait_id` (string, optional, nullable)

### BillingPlanCreditGrantResponseData

- `auto_topup_availability` (enum, required)
  - Allowed values: `off`, `automatic`, `user_controlled`
- `billing_mode` (enum, required) — Whether the credits are included in the plan price (granted) or billed as their own subscription line at a price per credit (billed).
  - Allowed values: `granted`, `billed`
- `company_credit_amount` (long, required) — Credits granted once per company on top of the per-license amount. Always 0 when scaling is fixed.
- `created_at` (datetime, required)
- `credit_amount` (long, required)
- `credit_id` (string, required)
- `id` (string, required)
- `plan_id` (string, required)
- `postpaid_enabled` (boolean, required) — Whether consumption may continue past a zero balance, accruing at postpaid_rate_per_unit rather than being denied.
- `price_tiers` (list of BillingPlanCreditGrantPriceTierResponseData, required) — Tier table pricing the credits, cheapest bound first. Empty unless billing_mode is billed and the credits are priced on tiers.
- `rollover_percentage` (long, required) — Percentage of unused credits that carry over when this grant resets. Only meaningful when reset_type is plan_period.
- `scaling` (enum, required) — Whether the grant is a fixed amount per company, or issued once per license the company holds.
  - Allowed values: `fixed`, `per_license`
- `updated_at` (datetime, required)
- `auto_topup_enabled` (boolean, required, deprecated) — Derived from auto_topup_availability; use that instead.
- `auto_topup_self_service` (boolean, required, deprecated) — Derived from auto_topup_availability; use that instead.
- `can_buy_bundles` (boolean, required, deprecated) — Deprecated: bundle availability is a per-bundle plan compatibility set now; use compatible_plan_ids on credit bundles instead.
- `credit_name` (string, required, deprecated) — Use credit.name from the nested credit object instead
- `plan_name` (string, required, deprecated) — Use plan.name from the nested plan object instead
- `arrears_anchor` (enum, optional, nullable) — Which boundary closes a monthly arrears window. Only meaningful when arrears_cadence is monthly.
  - Allowed values: `billing_period_start`, `month_end`
- `arrears_cadence` (enum, optional, nullable) — How often postpaid charges are closed and invoiced. Defaults to end_of_billing_period.
  - Allowed values: `end_of_billing_period`, `monthly`, `quarterly`
- `auto_topup_amount` (long, optional, nullable)
- `auto_topup_amount_type` (string, optional, nullable)
- `auto_topup_expiry_type` (enum, optional, nullable)
  - Allowed values: `duration`, `end_of_billing_period`, `end_of_next_billing_period`, `end_of_trial`, `no_expiry`
- `auto_topup_expiry_unit` (enum, optional, nullable)
  - Allowed values: `billing_periods`, `days`
- `auto_topup_expiry_unit_count` (long, optional, nullable)
- `auto_topup_threshold_credits` (long, optional, nullable)
- `auto_topup_threshold_percent` (long, optional, nullable)
- `credit` (BillingCreditResponseData, optional)
- `expiry_type` (enum, optional, nullable)
  - Allowed values: `duration`, `end_of_billing_period`, `end_of_next_billing_period`, `end_of_trial`, `no_expiry`
- `expiry_unit` (enum, optional, nullable)
  - Allowed values: `billing_periods`, `days`
- `expiry_unit_count` (long, optional, nullable)
- `license_id` (string, optional, nullable) — The license whose quantity scales this grant. Set only when scaling is per_license.
- `overdraft_limit` (double, optional, nullable) — Optional limit on how far the balance may go below zero, in credits. A floor on the balance, not an allowance per invoice window: consumption is denied once the balance would fall below minus this figure, and stays denied until a new grant lands or the negative balance is settled. Absent means no limit.
- `plan` (PreviewObjectResponseData, optional)
- `plan_version_id` (string, optional, nullable)
- `postpaid_rate_per_unit` (long, optional, nullable) — Amount charged per credit consumed past zero, in the currency's minor unit. Defaults to the credit's own cost basis when postpaid is enabled without one.
- `postpaid_rate_per_unit_decimal` (string, optional, nullable) — Decimal form of postpaid_rate_per_unit, for rates finer than one minor unit.
- `price` (BillingPriceResponseData, optional) — The Stripe price a billed grant bills through. Minted when the plan version is published.
- `reset_cadence` (enum, optional, nullable)
  - Allowed values: `daily`, `every_6_months`, `monthly`, `quarterly`, `weekly`, `yearly`
- `reset_start` (enum, optional, nullable)
  - Allowed values: `billing_period`, `first_of_month`
- `reset_type` (enum, optional, nullable)
  - Allowed values: `no_reset`, `plan_period`
- `tier_mode` (enum, optional, nullable) — How price_tiers apply: volume prices every credit at the rate of the tier the total lands in, graduated prices each tier's own credits at its own rate. Set only when price_tiers is non-empty.
  - Allowed values: `graduated`, `volume`
- `unit_price` (long, optional, nullable) — Price per credit in the plan currency's smallest unit. Set only when billing_mode is billed and the credits are priced at one rate.
- `unit_price_decimal` (string, optional, nullable) — Price per credit as a decimal in the plan currency's smallest unit. Set only when billing_mode is billed and the rate is below one cent.
- `credit_plural_name` (string, optional, nullable, deprecated) — Use plural_name from the nested credit object instead
- `credit_singular_name` (string, optional, nullable, deprecated) — Use singular_name from the nested credit object instead

### BillingPriceResponseData

- `currency` (string, required)
- `external_price_id` (string, required)
- `id` (string, required)
- `interval` (enum, required)
  - Allowed values: `day`, `month`, `one-time`, `year`
- `interval_count` (long, required)
- `price` (long, required)
- `provider_type` (enum, required)
  - Allowed values: `metronome`, `orb`, `schematic`, `stripe`
- `scheme` (enum, required)
  - Allowed values: `per_unit`, `tiered`
- `nickname` (string, optional, nullable)
- `price_decimal` (string, optional, nullable)

### CreditCurrencyPriceResponseData

- `currency` (string, required)
- `price` (BillingPriceResponseData, optional)

### BillingProductResponseData

- `account_id` (string, required)
- `created_at` (datetime, required)
- `environment_id` (string, required)
- `external_id` (string, required)
- `is_active` (boolean, required)
- `name` (string, required)
- `price` (double, required)
- `product_id` (string, required)
- `provider_type` (enum, required)
  - Allowed values: `metronome`, `orb`, `schematic`, `stripe`
- `quantity` (double, required)
- `updated_at` (datetime, required)
- `price_decimal` (string, optional, nullable)
- `currency` (string, optional, nullable, deprecated) — Deprecated; currencies are associated with prices, not products

### FlagInPlanResponseData

- `created_at` (datetime, required)
- `default_value` (boolean, required)
- `description` (string, required)
- `flag_type` (enum, required)
  - Allowed values: `boolean`
- `id` (string, required)
- `key` (string, required)
- `name` (string, required)
- `rules` (list of RuleDetailResponseData, required)
- `updated_at` (datetime, required)
- `feature` (FeatureResponseData, optional)
- `feature_id` (string, optional, nullable)
- `last_checked_at` (datetime, optional, nullable)
- `maintainer_account_member_id` (string, optional, nullable)

### PreviewObject

- `id` (string, required)
- `name` (string, required)
- `description` (string, optional, nullable)
- `image_url` (string, optional, nullable)

### EventSummaryResponseData

- `company_count` (long, required)
- `environment_id` (string, required)
- `event_count` (long, required)
- `event_subtype` (string, required)
- `user_count` (long, required)
- `last_seen_at` (datetime, optional, nullable)

### EntityTraitDefinitionResponseData

- `created_at` (datetime, required)
- `display_name` (string, required)
- `entity_type` (enum, required)
  - Allowed values: `company`, `user`
- `hierarchy` (list of string, required)
- `id` (string, required)
- `trait_type` (enum, required)
  - Allowed values: `boolean`, `currency`, `date`, `number`, `string`, `url`
- `updated_at` (datetime, required)

### EntitlementCurrencyPricesResponseData

- `currency` (string, required)
- `monthly_price` (BillingPriceView, optional)
- `quarterly_price` (BillingPriceView, optional)
- `yearly_price` (BillingPriceView, optional)

### WarningTierResponseData

- `id` (string, required)
- `key` (string, required)
- `value` (long, required)

### FeatureResponseData

- `created_at` (datetime, required)
- `description` (string, required)
- `feature_type` (enum, required)
  - Allowed values: `boolean`, `event`, `license`, `trait`
- `icon` (string, required)
- `id` (string, required)
- `name` (string, required)
- `updated_at` (datetime, required)
- `event_subtype` (string, optional, nullable)
- `license_id` (string, optional, nullable) — The license sold through this feature. Set only on features of type license, and created automatically with them.
- `lifecycle_phase` (enum, optional, nullable)
  - Allowed values: `add_on`, `alpha`, `beta`, `deprecated`, `ga`, `inactive`, `in_plan`, `internal_testing`, `legacy`
- `maintainer_account_member_id` (string, optional, nullable)
- `plural_name` (string, optional, nullable)
- `singular_name` (string, optional, nullable)
- `trait_id` (string, optional, nullable)
- `usage_limit_trait_id` (string, optional, nullable) — Set when the feature carries a pay-in-advance quantity. Provisioned lazily for other feature types, and at creation for license features.

### BillingPriceView

- `billing_scheme` (enum, required)
  - Allowed values: `per_unit`, `tiered`
- `created_at` (datetime, required)
- `currency` (string, required)
- `id` (string, required)
- `interval` (enum, required)
  - Allowed values: `day`, `month`, `one-time`, `year`
- `interval_count` (long, required)
- `is_active` (boolean, required)
- `package_size` (long, required)
- `price` (long, required)
- `price_external_id` (string, required)
- `price_id` (string, required)
- `price_tier` (list of BillingProductPriceTierResponseData, required)
- `product_external_id` (string, required)
- `product_id` (string, required)
- `product_name` (string, required)
- `provider_type` (enum, required)
  - Allowed values: `metronome`, `orb`, `schematic`, `stripe`
- `updated_at` (datetime, required)
- `usage_type` (enum, required)
  - Allowed values: `licensed`, `metered`
- `meter_event_name` (string, optional, nullable)
- `meter_event_payload_key` (string, optional, nullable)
- `meter_id` (string, optional, nullable)
- `nickname` (string, optional, nullable)
- `price_decimal` (string, optional, nullable)
- `tiers_mode` (enum, optional, nullable)
  - Allowed values: `graduated`, `volume`

### PlanResponseData

- `created_at` (datetime, required)
- `description` (string, required)
- `icon` (enum, required)
  - Allowed values: `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`
- `id` (string, required)
- `name` (string, required)
- `plan_type` (enum, required)
  - Allowed values: `plan`, `add_on`
- `updated_at` (datetime, required)
- `company_id` (string, optional, nullable)
- `copied_from_plan_id` (string, optional, nullable)
- `audience_type` (string, optional, nullable, deprecated)

### BillingPlanCreditGrantPriceTierResponseData

- `from` (long, required) — Lower bound of the tier, in credits per invoice (inclusive).
- `per_unit_price` (long, optional, nullable) — Price per credit in this tier, in the plan currency's smallest unit.
- `per_unit_price_decimal` (string, optional, nullable) — Price per credit in this tier as a decimal, for rates below one cent.
- `to` (long, optional, nullable) — Upper bound of the tier, in credits per invoice (inclusive). Null marks the final, unbounded tier.

### PreviewObjectResponseData

- `id` (string, required)
- `name` (string, required)
- `description` (string, optional, nullable)
- `image_url` (string, optional, nullable)

### RuleDetailResponseData

- `condition_groups` (list of RuleConditionGroupDetailResponseData, required)
- `conditions` (list of RuleConditionDetailResponseData, required)
- `created_at` (datetime, required)
- `environment_id` (string, required)
- `id` (string, required)
- `name` (string, required)
- `priority` (long, required)
- `rule_type` (enum, required)
  - Allowed values: `company_override`, `company_override_usage_exceeded`, `default`, `global_override`, `plan_entitlement`, `plan_entitlement_usage_exceeded`, `standard`
- `updated_at` (datetime, required)
- `value` (boolean, required)
- `flag_id` (string, optional, nullable)

### BillingProductPriceTierResponseData

- `flat_amount` (long, optional, nullable)
- `per_unit_price` (long, optional, nullable)
- `per_unit_price_decimal` (string, optional, nullable)
- `up_to` (long, optional, nullable)

### RuleConditionGroupDetailResponseData

- `conditions` (list of RuleConditionDetailResponseData, required)
- `created_at` (datetime, required)
- `environment_id` (string, required)
- `id` (string, required)
- `rule_id` (string, required)
- `updated_at` (datetime, required)
- `flag_id` (string, optional, nullable)

### RuleConditionDetailResponseData

- `condition_type` (enum, required)
  - Allowed values: `base_plan`, `billing_product`, `company`, `credit`, `metric`, `plan`, `plan_version`, `trait`, `user`
- `created_at` (datetime, required)
- `environment_id` (string, required)
- `id` (string, required)
- `operator` (enum, required)
  - Allowed values: `eq`, `gt`, `gte`, `is_empty`, `lt`, `lte`, `not_empty`, `ne`
- `resource_ids` (list of string, required)
- `resources` (list of PreviewObjectResponseData, required)
- `rule_id` (string, required)
- `trait_value` (string, required)
- `updated_at` (datetime, required)
- `comparison_trait` (EntityTraitDefinitionResponseData, optional)
- `comparison_trait_id` (string, optional, nullable)
- `condition_group_id` (string, optional, nullable)
- `event_subtype` (string, optional, nullable)
- `flag_id` (string, optional, nullable)
- `metric_period` (enum, optional, nullable)
  - Allowed values: `all_time`, `current_day`, `current_month`, `current_week`
- `metric_period_month_reset` (enum, optional, nullable)
  - Allowed values: `billing_cycle`, `first_of_month`
- `metric_value` (long, optional, nullable)
- `plan_versions` (list of RuleConditionPlanVersionResponseData, optional)
- `trait` (EntityTraitDefinitionResponseData, optional)
- `trait_entity_type` (enum, optional, nullable)
  - Allowed values: `company`, `user`
- `trait_id` (string, optional, nullable)

### RuleConditionPlanVersionResponseData

- `id` (string, required)
- `name` (string, required)
- `status` (enum, required)
  - Allowed values: `published`, `draft`, `archived`
- `version` (long, required)

## Examples

**Request**

```json
{
  "name": "string"
}
```

**Response**

```json
{
  "data": {
    "billing_strategy": "schematic_managed",
    "charge_type": "free",
    "company_count": 1,
    "controlled_by": "metronome",
    "created_at": "2024-01-15T09:30:00Z",
    "credits": [
      {
        "burn_strategy": "expiration_priority",
        "cost_editable": true,
        "created_at": "2024-01-15T09:30:00Z",
        "currency_prices": [
          {
            "currency": "string",
            "price": {
              "currency": "string",
              "external_price_id": "string",
              "id": "string",
              "interval": "day",
              "interval_count": 1,
              "price": 1,
              "provider_type": "metronome",
              "scheme": "per_unit",
              "nickname": "string",
              "price_decimal": "string"
            }
          }
        ],
        "default_expiry_unit": "billing_periods",
        "default_rollover_policy": "expire",
        "description": "string",
        "id": "string",
        "ledger_authority": "schematic_authoritative",
        "name": "string",
        "updated_at": "2024-01-15T09:30:00Z",
        "default_expiry_unit_count": 1,
        "icon": "string",
        "plural_name": "string",
        "price": {
          "currency": "string",
          "external_price_id": "string",
          "id": "string",
          "interval": "day",
          "interval_count": 1,
          "price": 1,
          "provider_type": "metronome",
          "scheme": "per_unit",
          "nickname": "string",
          "price_decimal": "string"
        },
        "product": {
          "account_id": "string",
          "created_at": "2024-01-15T09:30:00Z",
          "environment_id": "string",
          "external_id": "string",
          "is_active": true,
          "name": "string",
          "price": 1.1,
          "product_id": "string",
          "provider_type": "metronome",
          "quantity": 1.1,
          "updated_at": "2024-01-15T09:30:00Z",
          "price_decimal": "string",
          "currency": "string"
        },
        "singular_name": "string"
      }
    ],
    "currency_prices": [
      {
        "currency": "string",
        "monthly_price": {
          "currency": "string",
          "external_price_id": "string",
          "id": "string",
          "interval": "day",
          "interval_count": 1,
          "price": 1,
          "provider_type": "metronome",
          "scheme": "per_unit",
          "nickname": "string",
          "price_decimal": "string"
        },
        "one_time_price": {
          "currency": "string",
          "external_price_id": "string",
          "id": "string",
          "interval": "day",
          "interval_count": 1,
          "price": 1,
          "provider_type": "metronome",
          "scheme": "per_unit",
          "nickname": "string",
          "price_decimal": "string"
        },
        "quarterly_price": {
          "currency": "string",
          "external_price_id": "string",
          "id": "string",
          "interval": "day",
          "interval_count": 1,
          "price": 1,
          "provider_type": "metronome",
          "scheme": "per_unit",
          "nickname": "string",
          "price_decimal": "string"
        },
        "yearly_price": {
          "currency": "string",
          "external_price_id": "string",
          "id": "string",
          "interval": "day",
          "interval_count": 1,
          "price": 1,
          "provider_type": "metronome",
          "scheme": "per_unit",
          "nickname": "string",
          "price_decimal": "string"
        }
      }
    ],
    "description": "string",
    "features": [
      {
        "created_at": "2024-01-15T09:30:00Z",
        "description": "string",
        "feature_type": "boolean",
        "flags": [
          {
            "created_at": "2024-01-15T09:30:00Z",
            "default_value": true,
            "description": "string",
            "flag_type": "boolean",
            "id": "string",
            "key": "string",
            "name": "string",
            "rules": [
              {
                "condition_groups": [
                  {
                    "conditions": [
                      {
                        "condition_type": "base_plan",
                        "created_at": "2024-01-15T09:30:00Z",
                        "environment_id": "string",
                        "id": "string",
                        "operator": "eq",
                        "resource_ids": [
                          "string"
                        ],
                        "resources": [
                          {
                            "id": "string",
                            "name": "string",
                            "description": "string",
                            "image_url": "string"
                          }
                        ],
                        "rule_id": "string",
                        "trait_value": "string",
                        "updated_at": "2024-01-15T09:30:00Z",
                        "comparison_trait": {
                          "created_at": "2024-01-15T09:30:00Z",
                          "display_name": "string",
                          "entity_type": "company",
                          "hierarchy": [
                            "string"
                          ],
                          "id": "string",
                          "trait_type": "boolean",
                          "updated_at": "2024-01-15T09:30:00Z"
                        },
                        "comparison_trait_id": "string",
                        "condition_group_id": "string",
                        "event_subtype": "string",
                        "flag_id": "string",
                        "metric_period": "all_time",
                        "metric_period_month_reset": "billing_cycle",
                        "metric_value": 1,
                        "plan_versions": [
                          {
                            "id": "string",
                            "name": "string",
                            "status": "published",
                            "version": 1
                          }
                        ],
                        "trait": {
                          "created_at": "2024-01-15T09:30:00Z",
                          "display_name": "string",
                          "entity_type": "company",
                          "hierarchy": [
                            "string"
                          ],
                          "id": "string",
                          "trait_type": "boolean",
                          "updated_at": "2024-01-15T09:30:00Z"
                        },
                        "trait_entity_type": "company",
                        "trait_id": "string"
                      }
                    ],
                    "created_at": "2024-01-15T09:30:00Z",
                    "environment_id": "string",
                    "id": "string",
                    "rule_id": "string",
                    "updated_at": "2024-01-15T09:30:00Z",
                    "flag_id": "string"
                  }
                ],
                "conditions": [
                  {
                    "condition_type": "base_plan",
                    "created_at": "2024-01-15T09:30:00Z",
                    "environment_id": "string",
                    "id": "string",
                    "operator": "eq",
                    "resource_ids": [
                      "string"
                    ],
                    "resources": [
                      {
                        "id": "string",
                        "name": "string",
                        "description": "string",
                        "image_url": "string"
                      }
                    ],
                    "rule_id": "string",
                    "trait_value": "string",
                    "updated_at": "2024-01-15T09:30:00Z",
                    "comparison_trait": {
                      "created_at": "2024-01-15T09:30:00Z",
                      "display_name": "string",
                      "entity_type": "company",
                      "hierarchy": [
                        "string"
                      ],
                      "id": "string",
                      "trait_type": "boolean",
                      "updated_at": "2024-01-15T09:30:00Z"
                    },
                    "comparison_trait_id": "string",
                    "condition_group_id": "string",
                    "event_subtype": "string",
                    "flag_id": "string",
                    "metric_period": "all_time",
                    "metric_period_month_reset": "billing_cycle",
                    "metric_value": 1,
                    "plan_versions": [
                      {
                        "id": "string",
                        "name": "string",
                        "status": "published",
                        "version": 1
                      }
                    ],
                    "trait": {
                      "created_at": "2024-01-15T09:30:00Z",
                      "display_name": "string",
                      "entity_type": "company",
                      "hierarchy": [
                        "string"
                      ],
                      "id": "string",
                      "trait_type": "boolean",
                      "updated_at": "2024-01-15T09:30:00Z"
                    },
                    "trait_entity_type": "company",
                    "trait_id": "string"
                  }
                ],
                "created_at": "2024-01-15T09:30:00Z",
                "environment_id": "string",
                "id": "string",
                "name": "string",
                "priority": 1,
                "rule_type": "company_override",
                "updated_at": "2024-01-15T09:30:00Z",
                "value": true,
                "flag_id": "string"
              }
            ],
            "updated_at": "2024-01-15T09:30:00Z",
            "feature": {
              "created_at": "2024-01-15T09:30:00Z",
              "description": "string",
              "feature_type": "boolean",
              "icon": "string",
              "id": "string",
              "name": "string",
              "updated_at": "2024-01-15T09:30:00Z",
              "event_subtype": "string",
              "license_id": "string",
              "lifecycle_phase": "add_on",
              "maintainer_account_member_id": "string",
              "plural_name": "string",
              "singular_name": "string",
              "trait_id": "string",
              "usage_limit_trait_id": "string"
            },
            "feature_id": "string",
            "last_checked_at": "2024-01-15T09:30:00Z",
            "maintainer_account_member_id": "string"
          }
        ],
        "icon": "string",
        "id": "string",
        "name": "string",
        "plans": [
          {
            "id": "string",
            "name": "string",
            "description": "string",
            "image_url": "string"
          }
        ],
        "updated_at": "2024-01-15T09:30:00Z",
        "billing_linked_resource": {
          "billing_provider": "metronome",
          "external_resource_id": "string",
          "originator": "metronome"
        },
        "event_subtype": "string",
        "event_summary": {
          "company_count": 1,
          "environment_id": "string",
          "event_count": 1,
          "event_subtype": "string",
          "user_count": 1,
          "last_seen_at": "2024-01-15T09:30:00Z"
        },
        "license_id": "string",
        "lifecycle_phase": "add_on",
        "maintainer_account_member_id": "string",
        "plural_name": "string",
        "singular_name": "string",
        "trait": {
          "created_at": "2024-01-15T09:30:00Z",
          "display_name": "string",
          "entity_type": "company",
          "hierarchy": [
            "string"
          ],
          "id": "string",
          "trait_type": "boolean",
          "updated_at": "2024-01-15T09:30:00Z"
        },
        "trait_id": "string",
        "usage_limit_trait_id": "string"
      }
    ],
    "icon": "amber",
    "id": "string",
    "is_trialable": true,
    "name": "string",
    "plan_type": "plan",
    "updated_at": "2024-01-15T09:30:00Z",
    "versions": [
      {
        "created_at": "2024-01-15T09:30:00Z",
        "description": "string",
        "environment_id": "string",
        "icon": "amber",
        "id": "string",
        "name": "string",
        "plan_type": "plan",
        "status": "published",
        "updated_at": "2024-01-15T09:30:00Z",
        "version": 1,
        "original_plan_id": "string"
      }
    ],
    "is_default": true,
    "active_version": {
      "created_at": "2024-01-15T09:30:00Z",
      "description": "string",
      "environment_id": "string",
      "icon": "amber",
      "id": "string",
      "name": "string",
      "plan_type": "plan",
      "status": "published",
      "updated_at": "2024-01-15T09:30:00Z",
      "version": 1,
      "original_plan_id": "string"
    },
    "billing_linked_resource": {
      "billing_provider": "metronome",
      "external_resource_id": "string",
      "originator": "metronome"
    },
    "billing_product": {
      "account_id": "string",
      "created_at": "2024-01-15T09:30:00Z",
      "environment_id": "string",
      "external_id": "string",
      "is_active": true,
      "name": "string",
      "price": 1.1,
      "prices": [
        {
          "currency": "string",
          "external_price_id": "string",
          "id": "string",
          "interval": "day",
          "interval_count": 1,
          "price": 1,
          "provider_type": "metronome",
          "scheme": "per_unit",
          "nickname": "string",
          "price_decimal": "string"
        }
      ],
      "product_id": "string",
      "provider_type": "metronome",
      "quantity": 1.1,
      "subscription_count": 1,
      "updated_at": "2024-01-15T09:30:00Z",
      "price_decimal": "string",
      "currency": "string"
    },
    "catalogs": [
      {
        "id": "string",
        "name": "string"
      }
    ],
    "company_id": "string",
    "company_logo_url": "string",
    "company_name": "string",
    "copied_from_plan_id": "string",
    "draft_version": {
      "created_at": "2024-01-15T09:30:00Z",
      "description": "string",
      "environment_id": "string",
      "icon": "amber",
      "id": "string",
      "name": "string",
      "plan_type": "plan",
      "status": "published",
      "updated_at": "2024-01-15T09:30:00Z",
      "version": 1,
      "original_plan_id": "string"
    },
    "entitlements": [
      {
        "created_at": "2024-01-15T09:30:00Z",
        "currency_prices": [
          {
            "currency": "string",
            "monthly_price": {
              "billing_scheme": "per_unit",
              "created_at": "2024-01-15T09:30:00Z",
              "currency": "string",
              "id": "string",
              "interval": "day",
              "interval_count": 1,
              "is_active": true,
              "package_size": 1,
              "price": 1,
              "price_external_id": "string",
              "price_id": "string",
              "price_tier": [
                {
                  "flat_amount": 1,
                  "per_unit_price": 1,
                  "per_unit_price_decimal": "string",
                  "up_to": 1
                }
              ],
              "product_external_id": "string",
              "product_id": "string",
              "product_name": "string",
              "provider_type": "metronome",
              "updated_at": "2024-01-15T09:30:00Z",
              "usage_type": "licensed",
              "meter_event_name": "string",
              "meter_event_payload_key": "string",
              "meter_id": "string",
              "nickname": "string",
              "price_decimal": "string",
              "tiers_mode": "graduated"
            },
            "quarterly_price": {
              "billing_scheme": "per_unit",
              "created_at": "2024-01-15T09:30:00Z",
              "currency": "string",
              "id": "string",
              "interval": "day",
              "interval_count": 1,
              "is_active": true,
              "package_size": 1,
              "price": 1,
              "price_external_id": "string",
              "price_id": "string",
              "price_tier": [
                {
                  "flat_amount": 1,
                  "per_unit_price": 1,
                  "per_unit_price_decimal": "string",
                  "up_to": 1
                }
              ],
              "product_external_id": "string",
              "product_id": "string",
              "product_name": "string",
              "provider_type": "metronome",
              "updated_at": "2024-01-15T09:30:00Z",
              "usage_type": "licensed",
              "meter_event_name": "string",
              "meter_event_payload_key": "string",
              "meter_id": "string",
              "nickname": "string",
              "price_decimal": "string",
              "tiers_mode": "graduated"
            },
            "yearly_price": {
              "billing_scheme": "per_unit",
              "created_at": "2024-01-15T09:30:00Z",
              "currency": "string",
              "id": "string",
              "interval": "day",
              "interval_count": 1,
              "is_active": true,
              "package_size": 1,
              "price": 1,
              "price_external_id": "string",
              "price_id": "string",
              "price_tier": [
                {
                  "flat_amount": 1,
                  "per_unit_price": 1,
                  "per_unit_price_decimal": "string",
                  "up_to": 1
                }
              ],
              "product_external_id": "string",
              "product_id": "string",
              "product_name": "string",
              "provider_type": "metronome",
              "updated_at": "2024-01-15T09:30:00Z",
              "usage_type": "licensed",
              "meter_event_name": "string",
              "meter_event_payload_key": "string",
              "meter_id": "string",
              "nickname": "string",
              "price_decimal": "string",
              "tiers_mode": "graduated"
            }
          }
        ],
        "environment_id": "string",
        "feature_id": "string",
        "id": "string",
        "plan_id": "string",
        "rule_id": "string",
        "updated_at": "2024-01-15T09:30:00Z",
        "value_type": "boolean",
        "warning_tiers": [
          {
            "id": "string",
            "key": "string",
            "value": 1
          }
        ],
        "billing_linked_resource": {
          "billing_provider": "metronome",
          "external_resource_id": "string",
          "originator": "metronome"
        },
        "billing_threshold": 1,
        "consumption_rate": 1.1,
        "feature": {
          "created_at": "2024-01-15T09:30:00Z",
          "description": "string",
          "feature_type": "boolean",
          "icon": "string",
          "id": "string",
          "name": "string",
          "updated_at": "2024-01-15T09:30:00Z",
          "event_subtype": "string",
          "license_id": "string",
          "lifecycle_phase": "add_on",
          "maintainer_account_member_id": "string",
          "plural_name": "string",
          "singular_name": "string",
          "trait_id": "string",
          "usage_limit_trait_id": "string"
        },
        "metered_monthly_price": {
          "billing_scheme": "per_unit",
          "created_at": "2024-01-15T09:30:00Z",
          "currency": "string",
          "id": "string",
          "interval": "day",
          "interval_count": 1,
          "is_active": true,
          "package_size": 1,
          "price": 1,
          "price_external_id": "string",
          "price_id": "string",
          "price_tier": [
            {
              "flat_amount": 1,
              "per_unit_price": 1,
              "per_unit_price_decimal": "string",
              "up_to": 1
            }
          ],
          "product_external_id": "string",
          "product_id": "string",
          "product_name": "string",
          "provider_type": "metronome",
          "updated_at": "2024-01-15T09:30:00Z",
          "usage_type": "licensed",
          "meter_event_name": "string",
          "meter_event_payload_key": "string",
          "meter_id": "string",
          "nickname": "string",
          "price_decimal": "string",
          "tiers_mode": "graduated"
        },
        "metered_quarterly_price": {
          "billing_scheme": "per_unit",
          "created_at": "2024-01-15T09:30:00Z",
          "currency": "string",
          "id": "string",
          "interval": "day",
          "interval_count": 1,
          "is_active": true,
          "package_size": 1,
          "price": 1,
          "price_external_id": "string",
          "price_id": "string",
          "price_tier": [
            {
              "flat_amount": 1,
              "per_unit_price": 1,
              "per_unit_price_decimal": "string",
              "up_to": 1
            }
          ],
          "product_external_id": "string",
          "product_id": "string",
          "product_name": "string",
          "provider_type": "metronome",
          "updated_at": "2024-01-15T09:30:00Z",
          "usage_type": "licensed",
          "meter_event_name": "string",
          "meter_event_payload_key": "string",
          "meter_id": "string",
          "nickname": "string",
          "price_decimal": "string",
          "tiers_mode": "graduated"
        },
        "metered_yearly_price": {
          "billing_scheme": "per_unit",
          "created_at": "2024-01-15T09:30:00Z",
          "currency": "string",
          "id": "string",
          "interval": "day",
          "interval_count": 1,
          "is_active": true,
          "package_size": 1,
          "price": 1,
          "price_external_id": "string",
          "price_id": "string",
          "price_tier": [
            {
              "flat_amount": 1,
              "per_unit_price": 1,
              "per_unit_price_decimal": "string",
              "up_to": 1
            }
          ],
          "product_external_id": "string",
          "product_id": "string",
          "product_name": "string",
          "provider_type": "metronome",
          "updated_at": "2024-01-15T09:30:00Z",
          "usage_type": "licensed",
          "meter_event_name": "string",
          "meter_event_payload_key": "string",
          "meter_id": "string",
          "nickname": "string",
          "price_decimal": "string",
          "tiers_mode": "graduated"
        },
        "metric_period": "all_time",
        "metric_period_month_reset": "billing_cycle",
        "overage_billing_cadence": "end_of_billing_period",
        "overage_invoice_anchor": "billing_period_start",
        "plan": {
          "created_at": "2024-01-15T09:30:00Z",
          "description": "string",
          "icon": "amber",
          "id": "string",
          "name": "string",
          "plan_type": "plan",
          "updated_at": "2024-01-15T09:30:00Z",
          "company_id": "string",
          "copied_from_plan_id": "string",
          "audience_type": "string"
        },
        "price_behavior": "credit_burndown",
        "rule_id_usage_exceeded": "string",
        "soft_limit": 1,
        "usage_based_product": {
          "account_id": "string",
          "created_at": "2024-01-15T09:30:00Z",
          "environment_id": "string",
          "external_id": "string",
          "is_active": true,
          "name": "string",
          "price": 1.1,
          "product_id": "string",
          "provider_type": "metronome",
          "quantity": 1.1,
          "updated_at": "2024-01-15T09:30:00Z",
          "price_decimal": "string",
          "currency": "string"
        },
        "usage_quantity": 1,
        "value_bool": true,
        "value_credit": {
          "burn_strategy": "expiration_priority",
          "cost_editable": true,
          "created_at": "2024-01-15T09:30:00Z",
          "currency_prices": [
            {
              "currency": "string",
              "price": {
                "currency": "string",
                "external_price_id": "string",
                "id": "string",
                "interval": "day",
                "interval_count": 1,
                "price": 1,
                "provider_type": "metronome",
                "scheme": "per_unit",
                "nickname": "string",
                "price_decimal": "string"
              }
            }
          ],
          "default_expiry_unit": "billing_periods",
          "default_rollover_policy": "expire",
          "description": "string",
          "id": "string",
          "ledger_authority": "schematic_authoritative",
          "name": "string",
          "updated_at": "2024-01-15T09:30:00Z",
          "default_expiry_unit_count": 1,
          "icon": "string",
          "plural_name": "string",
          "price": {
            "currency": "string",
            "external_price_id": "string",
            "id": "string",
            "interval": "day",
            "interval_count": 1,
            "price": 1,
            "provider_type": "metronome",
            "scheme": "per_unit",
            "nickname": "string",
            "price_decimal": "string"
          },
          "product": {
            "account_id": "string",
            "created_at": "2024-01-15T09:30:00Z",
            "environment_id": "string",
            "external_id": "string",
            "is_active": true,
            "name": "string",
            "price": 1.1,
            "product_id": "string",
            "provider_type": "metronome",
            "quantity": 1.1,
            "updated_at": "2024-01-15T09:30:00Z",
            "price_decimal": "string",
            "currency": "string"
          },
          "singular_name": "string"
        },
        "value_numeric": 1,
        "value_trait": {
          "created_at": "2024-01-15T09:30:00Z",
          "display_name": "string",
          "entity_type": "company",
          "hierarchy": [
            "string"
          ],
          "id": "string",
          "trait_type": "boolean",
          "updated_at": "2024-01-15T09:30:00Z"
        },
        "value_trait_id": "string"
      }
    ],
    "included_credit_grants": [
      {
        "auto_topup_availability": "off",
        "billing_mode": "granted",
        "company_credit_amount": 1,
        "created_at": "2024-01-15T09:30:00Z",
        "credit_amount": 1,
        "credit_id": "string",
        "id": "string",
        "plan_id": "string",
        "postpaid_enabled": true,
        "price_tiers": [
          {
            "from": 1,
            "per_unit_price": 1,
            "per_unit_price_decimal": "string",
            "to": 1
          }
        ],
        "rollover_percentage": 1,
        "scaling": "fixed",
        "updated_at": "2024-01-15T09:30:00Z",
        "auto_topup_enabled": true,
        "auto_topup_self_service": true,
        "can_buy_bundles": true,
        "credit_name": "string",
        "plan_name": "string",
        "arrears_anchor": "billing_period_start",
        "arrears_cadence": "end_of_billing_period",
        "auto_topup_amount": 1,
        "auto_topup_amount_type": "string",
        "auto_topup_expiry_type": "duration",
        "auto_topup_expiry_unit": "billing_periods",
        "auto_topup_expiry_unit_count": 1,
        "auto_topup_threshold_credits": 1,
        "auto_topup_threshold_percent": 1,
        "credit": {
          "burn_strategy": "expiration_priority",
          "cost_editable": true,
          "created_at": "2024-01-15T09:30:00Z",
          "currency_prices": [
            {
              "currency": "string",
              "price": {
                "currency": "string",
                "external_price_id": "string",
                "id": "string",
                "interval": "day",
                "interval_count": 1,
                "price": 1,
                "provider_type": "metronome",
                "scheme": "per_unit",
                "nickname": "string",
                "price_decimal": "string"
              }
            }
          ],
          "default_expiry_unit": "billing_periods",
          "default_rollover_policy": "expire",
          "description": "string",
          "id": "string",
          "ledger_authority": "schematic_authoritative",
          "name": "string",
          "updated_at": "2024-01-15T09:30:00Z",
          "default_expiry_unit_count": 1,
          "icon": "string",
          "plural_name": "string",
          "price": {
            "currency": "string",
            "external_price_id": "string",
            "id": "string",
            "interval": "day",
            "interval_count": 1,
            "price": 1,
            "provider_type": "metronome",
            "scheme": "per_unit",
            "nickname": "string",
            "price_decimal": "string"
          },
          "product": {
            "account_id": "string",
            "created_at": "2024-01-15T09:30:00Z",
            "environment_id": "string",
            "external_id": "string",
            "is_active": true,
            "name": "string",
            "price": 1.1,
            "product_id": "string",
            "provider_type": "metronome",
            "quantity": 1.1,
            "updated_at": "2024-01-15T09:30:00Z",
            "price_decimal": "string",
            "currency": "string"
          },
          "singular_name": "string"
        },
        "expiry_type": "duration",
        "expiry_unit": "billing_periods",
        "expiry_unit_count": 1,
        "license_id": "string",
        "overdraft_limit": 1.1,
        "plan": {
          "id": "string",
          "name": "string",
          "description": "string",
          "image_url": "string"
        },
        "plan_version_id": "string",
        "postpaid_rate_per_unit": 1,
        "postpaid_rate_per_unit_decimal": "string",
        "price": {
          "currency": "string",
          "external_price_id": "string",
          "id": "string",
          "interval": "day",
          "interval_count": 1,
          "price": 1,
          "provider_type": "metronome",
          "scheme": "per_unit",
          "nickname": "string",
          "price_decimal": "string"
        },
        "reset_cadence": "daily",
        "reset_start": "billing_period",
        "reset_type": "no_reset",
        "tier_mode": "graduated",
        "unit_price": 1,
        "unit_price_decimal": "string",
        "credit_plural_name": "string",
        "credit_singular_name": "string"
      }
    ],
    "monthly_price": {
      "currency": "string",
      "external_price_id": "string",
      "id": "string",
      "interval": "day",
      "interval_count": 1,
      "price": 1,
      "provider_type": "metronome",
      "scheme": "per_unit",
      "nickname": "string",
      "price_decimal": "string"
    },
    "one_time_price": {
      "currency": "string",
      "external_price_id": "string",
      "id": "string",
      "interval": "day",
      "interval_count": 1,
      "price": 1,
      "provider_type": "metronome",
      "scheme": "per_unit",
      "nickname": "string",
      "price_decimal": "string"
    },
    "quarterly_price": {
      "currency": "string",
      "external_price_id": "string",
      "id": "string",
      "interval": "day",
      "interval_count": 1,
      "price": 1,
      "provider_type": "metronome",
      "scheme": "per_unit",
      "nickname": "string",
      "price_decimal": "string"
    },
    "trial_days": 1,
    "yearly_price": {
      "currency": "string",
      "external_price_id": "string",
      "id": "string",
      "interval": "day",
      "interval_count": 1,
      "price": 1,
      "provider_type": "metronome",
      "scheme": "per_unit",
      "nickname": "string",
      "price_decimal": "string"
    },
    "audience_type": "string",
    "is_free": true
  },
  "params": {}
}
```

**SDK Code**

```python
import requests

url = "https://api.schematichq.com/plans/plan_id"

payload = { "name": "string" }
headers = {
    "X-Schematic-Api-Key": "<apiKey>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api.schematichq.com/plans/plan_id';
const options = {
  method: 'PUT',
  headers: {'X-Schematic-Api-Key': '<apiKey>', 'Content-Type': 'application/json'},
  body: '{"name":"string"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.schematichq.com/plans/plan_id"

	payload := strings.NewReader("{\n  \"name\": \"string\"\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("X-Schematic-Api-Key", "<apiKey>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.schematichq.com/plans/plan_id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["X-Schematic-Api-Key"] = '<apiKey>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"string\"\n}"

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.put("https://api.schematichq.com/plans/plan_id")
  .header("X-Schematic-Api-Key", "<apiKey>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"string\"\n}")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('PUT', 'https://api.schematichq.com/plans/plan_id', [
  'body' => '{
  "name": "string"
}',
  'headers' => [
    'Content-Type' => 'application/json',
    'X-Schematic-Api-Key' => '<apiKey>',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.schematichq.com/plans/plan_id");
var request = new RestRequest(Method.PUT);
request.AddHeader("X-Schematic-Api-Key", "<apiKey>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"name\": \"string\"\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "X-Schematic-Api-Key": "<apiKey>",
  "Content-Type": "application/json"
]
let parameters = ["name": "string"] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api.schematichq.com/plans/plan_id")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "PUT"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```