entitlements
Create plan entitlement
post/plan-entitlements
Request body
billing_product_idstring nullable
billing_thresholdinteger nullable
credit_consumption_ratenumber double nullable
currencystring nullable
feature_idstring required
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_product_idstring nullable
plan_idstring required
plan_version_idstring nullable
price_behavior'credit_burndown' | 'overage' | 'pay_as_you_go' | 'pay_in_advance' | 'tier'
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 quantity the company is contractually committed to; for standard plans it is the quantity pre-filled when subscribing. Only applies to pay-in-advance entitlements. Note: this is not yet enforced/auto-provisioned as a true default — it is currently stored for downstream billing use.
value_boolboolean nullable
value_credit_idstring nullable
value_numericinteger nullable
value_trait_idstring nullable
value_type'boolean' | 'credit' | 'numeric' | 'trait' | 'unknown' | 'unlimited' required
yearly_metered_price_idstring nullable
yearly_unit_priceinteger nullable
yearly_unit_price_decimalstring nullable
Response
Created
paramsobject required
Input parameters