> 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 entitlement

PUT https://api.schematichq.com/plan-entitlements/{plan_entitlement_id}
Content-Type: application/json

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

## Authentication

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

## Request

### Path parameters

- `plan_entitlement_id` (string, required) — plan_entitlement_id

### Body (application/json)

This endpoint expects an UpdatePlanEntitlementRequestBody.

- `value_type` (enum, required)
  - Allowed values: `boolean`, `credit`, `numeric`, `trait`, `unknown`, `unlimited`
- `billing_product_id` (string, optional, nullable)
- `billing_threshold` (long, optional, nullable)
- `credit_consumption_rate` (double, optional, nullable)
- `currency` (enum, optional, nullable)
  - Allowed values: `aed`, `afn`, `all`, `amd`, `ang`, `aoa`, `ars`, `aud`, `awg`, `azn`, `bam`, `bbd`, `bdt`, `bif`, `bmd`, `bnd`, `bob`, `brl`, `bsd`, `bwp`, `byn`, `bzd`, `cad`, `cdf`, `chf`, `clp`, `cny`, `cop`, `crc`, `cve`, `czk`, `djf`, `dkk`, `dop`, `dzd`, `egp`, `etb`, `eur`, `fjd`, `fkp`, `gbp`, `gel`, `gip`, `gmd`, `gnf`, `gtq`, `gyd`, `hkd`, `hnl`, `htg`, `huf`, `idr`, `ils`, `inr`, `isk`, `jmd`, `jpy`, `kes`, `kgs`, `khr`, `kmf`, `krw`, `kyd`, `kzt`, `lak`, `lbp`, `lkr`, `lrd`, `lsl`, `mad`, `mdl`, `mga`, `mkd`, `mmk`, `mnt`, `mop`, `mur`, `mvr`, `mwk`, `mxn`, `myr`, `mzn`, `nad`, `ngn`, `nio`, `nok`, `npr`, `nzd`, `pab`, `pen`, `pgk`, `php`, `pkr`, `pln`, `pyg`, `qar`, `ron`, `rsd`, `rub`, `rwf`, `sar`, `sbd`, `scr`, `sek`, `sgd`, `shp`, `sle`, `sos`, `srd`, `std`, `szl`, `thb`, `tjs`, `top`, `try`, `ttd`, `twd`, `tzs`, `uah`, `ugx`, `usd`, `uyu`, `uzs`, `vnd`, `vuv`, `wst`, `xaf`, `xcd`, `xcg`, `xof`, `xpf`, `yer`, `zar`, `zmw`
- `currency_prices` (list of CurrencyPriceRequestBody, 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`
- `monthly_price_tiers` (list of CreatePriceTierRequestBody, optional, nullable)
- `monthly_unit_price` (long, optional, nullable)
- `monthly_unit_price_decimal` (string, optional, nullable)
- `overage_billing_cadence` (enum, optional, nullable) — How often overage charges are assessed and invoiced. Defaults to end_of_billing_period, where the billing provider aggregates usage over the subscription's own period and bills it at period end. Set to monthly or quarterly to have overage assessed each month or quarter and billed on its own invoice, which is the point of the setting on annual plans. A quarter charges each month's usage against that month's allowance. 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). Quarterly windows run in three-month blocks from the billing period start, held to the subscription's own period, or in calendar quarters at month_end. Only applies when overage_billing_cadence is monthly or quarterly, and must match metric_period_month_reset so each window closes when the allowance resets: billing_period_start for billing_cycle, month_end for first_of_month. Defaults to the anchor that matches the reset.
  - Allowed values: `billing_period_start`, `month_end`
- `price_behavior` (enum, optional, nullable)
  - Allowed values: `credit_burndown`, `overage`, `pay_as_you_go`, `pay_in_advance`, `tier`
- `quarterly_price_tiers` (list of CreatePriceTierRequestBody, optional, nullable)
- `quarterly_unit_price` (long, optional, nullable)
- `quarterly_unit_price_decimal` (string, optional, nullable)
- `soft_limit` (long, optional, nullable)
- `tier_mode` (enum, optional, nullable)
  - Allowed values: `graduated`, `volume`
- `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_id` (string, optional, nullable)
- `value_numeric` (long, optional, nullable)
- `value_trait_id` (string, optional, nullable)
- `warning_tiers` (list of WarningTierRequestBody, optional, nullable)
- `yearly_price_tiers` (list of CreatePriceTierRequestBody, optional, nullable)
- `yearly_unit_price` (long, optional, nullable)
- `yearly_unit_price_decimal` (string, optional, nullable)
- `monthly_metered_price_id` (string, optional, nullable, deprecated)
- `overage_billing_product_id` (string, optional, nullable, deprecated)
- `price_tiers` (list of CreatePriceTierRequestBody, optional, nullable, deprecated) — Use MonthlyPriceTiers or YearlyPriceTiers instead
- `quarterly_metered_price_id` (string, optional, nullable, deprecated)
- `yearly_metered_price_id` (string, optional, nullable, deprecated)

## Response

### 200

OK

- `data` (PlanEntitlementResponseData, required)
- `params` (PlanEntitlementsPlanEntitlementIdPutResponsesContentApplicationJsonSchemaParams, 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

### CurrencyPriceRequestBody

- `currency` (enum, required)
  - Allowed values: `aed`, `afn`, `all`, `amd`, `ang`, `aoa`, `ars`, `aud`, `awg`, `azn`, `bam`, `bbd`, `bdt`, `bif`, `bmd`, `bnd`, `bob`, `brl`, `bsd`, `bwp`, `byn`, `bzd`, `cad`, `cdf`, `chf`, `clp`, `cny`, `cop`, `crc`, `cve`, `czk`, `djf`, `dkk`, `dop`, `dzd`, `egp`, `etb`, `eur`, `fjd`, `fkp`, `gbp`, `gel`, `gip`, `gmd`, `gnf`, `gtq`, `gyd`, `hkd`, `hnl`, `htg`, `huf`, `idr`, `ils`, `inr`, `isk`, `jmd`, `jpy`, `kes`, `kgs`, `khr`, `kmf`, `krw`, `kyd`, `kzt`, `lak`, `lbp`, `lkr`, `lrd`, `lsl`, `mad`, `mdl`, `mga`, `mkd`, `mmk`, `mnt`, `mop`, `mur`, `mvr`, `mwk`, `mxn`, `myr`, `mzn`, `nad`, `ngn`, `nio`, `nok`, `npr`, `nzd`, `pab`, `pen`, `pgk`, `php`, `pkr`, `pln`, `pyg`, `qar`, `ron`, `rsd`, `rub`, `rwf`, `sar`, `sbd`, `scr`, `sek`, `sgd`, `shp`, `sle`, `sos`, `srd`, `std`, `szl`, `thb`, `tjs`, `top`, `try`, `ttd`, `twd`, `tzs`, `uah`, `ugx`, `usd`, `uyu`, `uzs`, `vnd`, `vuv`, `wst`, `xaf`, `xcd`, `xcg`, `xof`, `xpf`, `yer`, `zar`, `zmw`
- `monthly_price_tiers` (list of CreatePriceTierRequestBody, optional, nullable)
- `monthly_unit_price` (long, optional, nullable)
- `monthly_unit_price_decimal` (string, optional, nullable)
- `quarterly_price_tiers` (list of CreatePriceTierRequestBody, optional, nullable)
- `quarterly_unit_price` (long, optional, nullable)
- `quarterly_unit_price_decimal` (string, optional, nullable)
- `yearly_price_tiers` (list of CreatePriceTierRequestBody, optional, nullable)
- `yearly_unit_price` (long, optional, nullable)
- `yearly_unit_price_decimal` (string, optional, nullable)

### CreatePriceTierRequestBody

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

### WarningTierRequestBody

- `key` (string, required)
- `value` (long, 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)

### PlanEntitlementsPlanEntitlementIdPutResponsesContentApplicationJsonSchemaParams

Input parameters

### EntitlementCurrencyPricesResponseData

- `currency` (enum, required)
  - Allowed values: `aed`, `afn`, `all`, `amd`, `ang`, `aoa`, `ars`, `aud`, `awg`, `azn`, `bam`, `bbd`, `bdt`, `bif`, `bmd`, `bnd`, `bob`, `brl`, `bsd`, `bwp`, `byn`, `bzd`, `cad`, `cdf`, `chf`, `clp`, `cny`, `cop`, `crc`, `cve`, `czk`, `djf`, `dkk`, `dop`, `dzd`, `egp`, `etb`, `eur`, `fjd`, `fkp`, `gbp`, `gel`, `gip`, `gmd`, `gnf`, `gtq`, `gyd`, `hkd`, `hnl`, `htg`, `huf`, `idr`, `ils`, `inr`, `isk`, `jmd`, `jpy`, `kes`, `kgs`, `khr`, `kmf`, `krw`, `kyd`, `kzt`, `lak`, `lbp`, `lkr`, `lrd`, `lsl`, `mad`, `mdl`, `mga`, `mkd`, `mmk`, `mnt`, `mop`, `mur`, `mvr`, `mwk`, `mxn`, `myr`, `mzn`, `nad`, `ngn`, `nio`, `nok`, `npr`, `nzd`, `pab`, `pen`, `pgk`, `php`, `pkr`, `pln`, `pyg`, `qar`, `ron`, `rsd`, `rub`, `rwf`, `sar`, `sbd`, `scr`, `sek`, `sgd`, `shp`, `sle`, `sos`, `srd`, `std`, `szl`, `thb`, `tjs`, `top`, `try`, `ttd`, `twd`, `tzs`, `uah`, `ugx`, `usd`, `uyu`, `uzs`, `vnd`, `vuv`, `wst`, `xaf`, `xcd`, `xcg`, `xof`, `xpf`, `yer`, `zar`, `zmw`
- `monthly_price` (BillingPriceView, optional)
- `quarterly_price` (BillingPriceView, optional)
- `yearly_price` (BillingPriceView, optional)

### WarningTierResponseData

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

### 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`

### 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` (enum, required)
  - Allowed values: `aed`, `afn`, `all`, `amd`, `ang`, `aoa`, `ars`, `aud`, `awg`, `azn`, `bam`, `bbd`, `bdt`, `bif`, `bmd`, `bnd`, `bob`, `brl`, `bsd`, `bwp`, `byn`, `bzd`, `cad`, `cdf`, `chf`, `clp`, `cny`, `cop`, `crc`, `cve`, `czk`, `djf`, `dkk`, `dop`, `dzd`, `egp`, `etb`, `eur`, `fjd`, `fkp`, `gbp`, `gel`, `gip`, `gmd`, `gnf`, `gtq`, `gyd`, `hkd`, `hnl`, `htg`, `huf`, `idr`, `ils`, `inr`, `isk`, `jmd`, `jpy`, `kes`, `kgs`, `khr`, `kmf`, `krw`, `kyd`, `kzt`, `lak`, `lbp`, `lkr`, `lrd`, `lsl`, `mad`, `mdl`, `mga`, `mkd`, `mmk`, `mnt`, `mop`, `mur`, `mvr`, `mwk`, `mxn`, `myr`, `mzn`, `nad`, `ngn`, `nio`, `nok`, `npr`, `nzd`, `pab`, `pen`, `pgk`, `php`, `pkr`, `pln`, `pyg`, `qar`, `ron`, `rsd`, `rub`, `rwf`, `sar`, `sbd`, `scr`, `sek`, `sgd`, `shp`, `sle`, `sos`, `srd`, `std`, `szl`, `thb`, `tjs`, `top`, `try`, `ttd`, `twd`, `tzs`, `uah`, `ugx`, `usd`, `uyu`, `uzs`, `vnd`, `vuv`, `wst`, `xaf`, `xcd`, `xcg`, `xof`, `xpf`, `yer`, `zar`, `zmw`
- `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)

### 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

### 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)

### 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)

### BillingProductPriceTierResponseData

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

### CreditCurrencyPriceResponseData

- `currency` (enum, required)
  - Allowed values: `aed`, `afn`, `all`, `amd`, `ang`, `aoa`, `ars`, `aud`, `awg`, `azn`, `bam`, `bbd`, `bdt`, `bif`, `bmd`, `bnd`, `bob`, `brl`, `bsd`, `bwp`, `byn`, `bzd`, `cad`, `cdf`, `chf`, `clp`, `cny`, `cop`, `crc`, `cve`, `czk`, `djf`, `dkk`, `dop`, `dzd`, `egp`, `etb`, `eur`, `fjd`, `fkp`, `gbp`, `gel`, `gip`, `gmd`, `gnf`, `gtq`, `gyd`, `hkd`, `hnl`, `htg`, `huf`, `idr`, `ils`, `inr`, `isk`, `jmd`, `jpy`, `kes`, `kgs`, `khr`, `kmf`, `krw`, `kyd`, `kzt`, `lak`, `lbp`, `lkr`, `lrd`, `lsl`, `mad`, `mdl`, `mga`, `mkd`, `mmk`, `mnt`, `mop`, `mur`, `mvr`, `mwk`, `mxn`, `myr`, `mzn`, `nad`, `ngn`, `nio`, `nok`, `npr`, `nzd`, `pab`, `pen`, `pgk`, `php`, `pkr`, `pln`, `pyg`, `qar`, `ron`, `rsd`, `rub`, `rwf`, `sar`, `sbd`, `scr`, `sek`, `sgd`, `shp`, `sle`, `sos`, `srd`, `std`, `szl`, `thb`, `tjs`, `top`, `try`, `ttd`, `twd`, `tzs`, `uah`, `ugx`, `usd`, `uyu`, `uzs`, `vnd`, `vuv`, `wst`, `xaf`, `xcd`, `xcg`, `xof`, `xpf`, `yer`, `zar`, `zmw`
- `price` (BillingPriceResponseData, optional)

### BillingPriceResponseData

- `currency` (enum, required)
  - Allowed values: `aed`, `afn`, `all`, `amd`, `ang`, `aoa`, `ars`, `aud`, `awg`, `azn`, `bam`, `bbd`, `bdt`, `bif`, `bmd`, `bnd`, `bob`, `brl`, `bsd`, `bwp`, `byn`, `bzd`, `cad`, `cdf`, `chf`, `clp`, `cny`, `cop`, `crc`, `cve`, `czk`, `djf`, `dkk`, `dop`, `dzd`, `egp`, `etb`, `eur`, `fjd`, `fkp`, `gbp`, `gel`, `gip`, `gmd`, `gnf`, `gtq`, `gyd`, `hkd`, `hnl`, `htg`, `huf`, `idr`, `ils`, `inr`, `isk`, `jmd`, `jpy`, `kes`, `kgs`, `khr`, `kmf`, `krw`, `kyd`, `kzt`, `lak`, `lbp`, `lkr`, `lrd`, `lsl`, `mad`, `mdl`, `mga`, `mkd`, `mmk`, `mnt`, `mop`, `mur`, `mvr`, `mwk`, `mxn`, `myr`, `mzn`, `nad`, `ngn`, `nio`, `nok`, `npr`, `nzd`, `pab`, `pen`, `pgk`, `php`, `pkr`, `pln`, `pyg`, `qar`, `ron`, `rsd`, `rub`, `rwf`, `sar`, `sbd`, `scr`, `sek`, `sgd`, `shp`, `sle`, `sos`, `srd`, `std`, `szl`, `thb`, `tjs`, `top`, `try`, `ttd`, `twd`, `tzs`, `uah`, `ugx`, `usd`, `uyu`, `uzs`, `vnd`, `vuv`, `wst`, `xaf`, `xcd`, `xcg`, `xof`, `xpf`, `yer`, `zar`, `zmw`
- `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)

## Examples

**Request**

```json
{
  "value_type": "boolean"
}
```

**Response**

```json
{
  "data": {
    "created_at": "2024-01-15T09:30:00Z",
    "currency_prices": [
      {
        "currency": "aed",
        "monthly_price": {
          "billing_scheme": "per_unit",
          "created_at": "2024-01-15T09:30:00Z",
          "currency": "aed",
          "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": "aed",
          "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": "aed",
          "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": "aed",
      "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": "aed",
      "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": "aed",
      "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": "aed",
          "price": {
            "currency": "aed",
            "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": "aed",
        "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"
  },
  "params": {}
}
```

**SDK Code**

```python
import requests

url = "https://api.schematichq.com/plan-entitlements/plan_entitlement_id"

payload = { "value_type": "boolean" }
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/plan-entitlements/plan_entitlement_id';
const options = {
  method: 'PUT',
  headers: {'X-Schematic-Api-Key': '<apiKey>', 'Content-Type': 'application/json'},
  body: '{"value_type":"boolean"}'
};

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/plan-entitlements/plan_entitlement_id"

	payload := strings.NewReader("{\n  \"value_type\": \"boolean\"\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/plan-entitlements/plan_entitlement_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  \"value_type\": \"boolean\"\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/plan-entitlements/plan_entitlement_id")
  .header("X-Schematic-Api-Key", "<apiKey>")
  .header("Content-Type", "application/json")
  .body("{\n  \"value_type\": \"boolean\"\n}")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

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

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

```csharp
using RestSharp;

var client = new RestClient("https://api.schematichq.com/plan-entitlements/plan_entitlement_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  \"value_type\": \"boolean\"\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

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

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

let request = NSMutableURLRequest(url: NSURL(string: "https://api.schematichq.com/plan-entitlements/plan_entitlement_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()
```