Create plan entitlement

1 import { SchematicClient } from "@schematichq/schematic-typescript-node"; 2 3 const client = new SchematicClient({ apiKey: "YOUR_API_KEY" }); 4 await client.entitlements.createPlanEntitlement({ 5 featureId: "feature_id", 6 planId: "plan_id", 7 valueType: "boolean" 8 });

1 { 2 "data": { 3 "created_at": "2024-01-15T09:30:00Z", 4 "environment_id": "environment_id", 5 "feature_id": "feature_id", 6 "id": "id", 7 "plan_id": "plan_id", 8 "rule_id": "rule_id", 9 "updated_at": "2024-01-15T09:30:00Z", 10 "value_type": "value_type", 11 "feature": { 12 "created_at": "2024-01-15T09:30:00Z", 13 "description": "description", 14 "feature_type": "feature_type", 15 "icon": "icon", 16 "id": "id", 17 "name": "name", 18 "updated_at": "2024-01-15T09:30:00Z", 19 "event_subtype": "event_subtype", 20 "lifecycle_phase": "lifecycle_phase", 21 "maintainer_id": "maintainer_id", 22 "plural_name": "plural_name", 23 "singular_name": "singular_name", 24 "trait_id": "trait_id" 25 }, 26 "metered_monthly_price": { 27 "created_at": "2024-01-15T09:30:00Z", 28 "currency": "currency", 29 "id": "id", 30 "interval": "interval", 31 "is_active": true, 32 "price": 1, 33 "price_external_id": "price_external_id", 34 "price_id": "price_id", 35 "product_external_id": "product_external_id", 36 "product_id": "product_id", 37 "product_name": "product_name", 38 "updated_at": "2024-01-15T09:30:00Z", 39 "usage_type": "usage_type", 40 "meter_id": "meter_id" 41 }, 42 "metered_yearly_price": { 43 "created_at": "2024-01-15T09:30:00Z", 44 "currency": "currency", 45 "id": "id", 46 "interval": "interval", 47 "is_active": true, 48 "price": 1, 49 "price_external_id": "price_external_id", 50 "price_id": "price_id", 51 "product_external_id": "product_external_id", 52 "product_id": "product_id", 53 "product_name": "product_name", 54 "updated_at": "2024-01-15T09:30:00Z", 55 "usage_type": "usage_type", 56 "meter_id": "meter_id" 57 }, 58 "metric_period": "metric_period", 59 "metric_period_month_reset": "metric_period_month_reset", 60 "plan": { 61 "created_at": "2024-01-15T09:30:00Z", 62 "description": "description", 63 "icon": "icon", 64 "id": "id", 65 "name": "name", 66 "plan_type": "plan_type", 67 "updated_at": "2024-01-15T09:30:00Z", 68 "audience_type": "audience_type" 69 }, 70 "price_behavior": "price_behavior", 71 "rule_id_usage_exceeded": "rule_id_usage_exceeded", 72 "soft_limit": 1, 73 "value_bool": true, 74 "value_numeric": 1, 75 "value_trait": { 76 "created_at": "2024-01-15T09:30:00Z", 77 "display_name": "display_name", 78 "entity_type": "entity_type", 79 "hierarchy": [ 80 "hierarchy" 81 ], 82 "id": "id", 83 "trait_type": "trait_type", 84 "updated_at": "2024-01-15T09:30:00Z" 85 }, 86 "value_trait_id": "value_trait_id" 87 }, 88 "params": { 89 "key": "value" 90 } 91 }

Request

This endpoint expects an object.

feature_idstringRequired

plan_idstringRequired

value_typeenumRequired

Allowed values:

metric_periodenumOptional

Allowed values:

metric_period_month_resetenumOptional

Allowed values:

monthly_metered_price_idstringOptional

price_behaviorstringOptional

soft_limitintegerOptional

value_boolbooleanOptional

value_numericintegerOptional

value_trait_idstringOptional

yearly_metered_price_idstringOptional

Response

Created

dataobject

paramsmap from strings to any

Input parameters

Create plan entitlement

Headers

Request

Response

Errors