entitlements

Update plan entitlement

Changed on Oct 6, 2026

put/plan-entitlements/{plan_entitlement_id}

Request

Base URL
https://api.schematichq.com
URL
https://api.schematichq.com/plan-entitlements/{plan_entitlement_id}
Auth
API key in header X-Schematic-Api-Key

Path parameters

plan_entitlement_idstring required

plan_entitlement_id

Request body

billing_product_idstring nullable

billing_thresholdinteger nullable

credit_consumption_ratenumber double nullable

currency'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'

metric_period'all_time' | 'current_day' | 'current_month' | 'current_week'

metric_period_month_reset'billing_cycle' | 'first_of_month'

monthly_metered_price_idstring nullable

monthly_unit_priceinteger nullable

monthly_unit_price_decimalstring nullable

overage_billing_cadence'end_of_billing_period' | 'monthly' | 'quarterly'

overage_billing_product_idstring nullable

overage_invoice_anchor'billing_period_start' | 'month_end'

price_behavior'credit_burndown' | 'overage' | 'pay_as_you_go' | 'pay_in_advance' | 'tier'

quantity_ratesobject nullable

Credits per unit of the quantity (per token for inference features), keyed by quantity key. Inference features may price input_tokens, output_tokens, cached_input_tokens, cache_creation_input_tokens and reasoning_tokens; reasoning_tokens is priced on top of output_tokens, so leave its rate at zero for providers that count reasoning inside output. Omit to leave the schedule as it is; send null to clear it.

quarterly_metered_price_idstring nullable

quarterly_unit_priceinteger nullable

quarterly_unit_price_decimalstring nullable

soft_limitinteger nullable

tier_mode'graduated' | 'volume'

usage_quantityinteger 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_boolboolean nullable

value_credit_idstring nullable

value_numericinteger nullable

value_trait_idstring nullable

yearly_metered_price_idstring nullable

yearly_unit_priceinteger nullable

yearly_unit_price_decimalstring nullable

Response

paramsobject required

Input parameters

Changes

Oct 6, 20268eb4adb2bade Revision changes
- info
  added the new optional request property
- info
  added the optional property / to the response with the status
- info
  added the required property // to the response with the status
Sep 22, 2026c4562bbfb527 Revision changes
- warning
  the //// request property's min was set to 0.00
- warning
  the //// request property's min was set to 0.00
- warning
  the // request property's min was set to 0.00
- warning
  the //// request property's min was set to 0.00
- warning
  the //// request property's min was set to 0.00
- warning
  the // request property's min was set to 0.00
- warning
  the //// request property's min was set to 0.00
- warning
  the //// request property's min was set to 0.00
- warning
  the // request property's min was set to 0.00
- warning
  the // request property's min was set to 0.00
- warning
  the // request property's min was set to 0.00
- warning
  the request property's min was set to 0.00
- warning
  the // request property's min was set to 0.00
- warning
  the // request property's min was set to 0.00
- warning
  the // request property's min was set to 0.00
- warning
  the // request property's min was set to 0.00
- warning
  the request property's min was set to 0.00
- warning
  the // request property's min was set to 0.00
- warning
  the // request property's min was set to 0.00
- warning
  the request property's min was set to 0.00

Operation history (10 revisions)