Create plan entitlement

Authentication

X-Schematic-Api-Keystring
API Key authentication via header

Request

This endpoint expects an object.
feature_idstringRequired
plan_idstringRequired
value_typeenumRequired
billing_product_idstring or nullOptional
billing_thresholdlong or nullOptional50-9999999999999
credit_consumption_ratedouble or nullOptional
currencystring or nullOptional
currency_priceslist of objects or nullOptional
metric_periodenum or nullOptional
metric_period_month_resetenum or nullOptional
monthly_price_tierslist of objects or nullOptional
monthly_unit_pricelong or nullOptional
monthly_unit_price_decimalstring or nullOptional
overage_billing_cadenceenum or nullOptional

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.

overage_invoice_anchorenum or nullOptional

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.

plan_version_idstring or nullOptional
price_behaviorenum or nullOptional
quarterly_price_tierslist of objects or nullOptional
quarterly_unit_pricelong or nullOptional
quarterly_unit_price_decimalstring or nullOptional
soft_limitlong or nullOptional
tier_modeenum or nullOptional
usage_quantitylong or nullOptional>=0

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 or nullOptional
value_credit_idstring or nullOptional
value_numericlong or nullOptional
value_trait_idstring or nullOptional
warning_tierslist of objects or nullOptional
yearly_price_tierslist of objects or nullOptional
yearly_unit_pricelong or nullOptional
yearly_unit_price_decimalstring or nullOptional
monthly_metered_price_idstring or nullOptionalDeprecated
overage_billing_product_idstring or nullOptionalDeprecated
price_tierslist of objects or nullOptionalDeprecated
Use MonthlyPriceTiers or YearlyPriceTiers instead
quarterly_metered_price_idstring or nullOptionalDeprecated
yearly_metered_price_idstring or nullOptionalDeprecated

Response

Created
dataobject
paramsobject
Input parameters

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
500
Internal Server Error