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 "billing_scheme": "billing_scheme", 28 "created_at": "2024-01-15T09:30:00Z", 29 "currency": "currency", 30 "id": "id", 31 "interval": "interval", 32 "is_active": true, 33 "package_size": 1, 34 "price": 1, 35 "price_external_id": "price_external_id", 36 "price_id": "price_id", 37 "price_tier": [ 38 {} 39 ], 40 "product_external_id": "product_external_id", 41 "product_id": "product_id", 42 "product_name": "product_name", 43 "updated_at": "2024-01-15T09:30:00Z", 44 "usage_type": "usage_type", 45 "meter_id": "meter_id", 46 "price_decimal": "price_decimal" 47 }, 48 "metered_yearly_price": { 49 "billing_scheme": "billing_scheme", 50 "created_at": "2024-01-15T09:30:00Z", 51 "currency": "currency", 52 "id": "id", 53 "interval": "interval", 54 "is_active": true, 55 "package_size": 1, 56 "price": 1, 57 "price_external_id": "price_external_id", 58 "price_id": "price_id", 59 "price_tier": [ 60 {} 61 ], 62 "product_external_id": "product_external_id", 63 "product_id": "product_id", 64 "product_name": "product_name", 65 "updated_at": "2024-01-15T09:30:00Z", 66 "usage_type": "usage_type", 67 "meter_id": "meter_id", 68 "price_decimal": "price_decimal" 69 }, 70 "metric_period": "metric_period", 71 "metric_period_month_reset": "metric_period_month_reset", 72 "plan": { 73 "created_at": "2024-01-15T09:30:00Z", 74 "description": "description", 75 "icon": "icon", 76 "id": "id", 77 "name": "name", 78 "plan_type": "plan_type", 79 "updated_at": "2024-01-15T09:30:00Z", 80 "audience_type": "audience_type" 81 }, 82 "price_behavior": "price_behavior", 83 "rule_id_usage_exceeded": "rule_id_usage_exceeded", 84 "soft_limit": 1, 85 "usage_based_product": { 86 "account_id": "account_id", 87 "created_at": "2024-01-15T09:30:00Z", 88 "currency": "currency", 89 "environment_id": "environment_id", 90 "external_id": "external_id", 91 "is_active": true, 92 "name": "name", 93 "price": 1.1, 94 "product_id": "product_id", 95 "quantity": 1.1, 96 "updated_at": "2024-01-15T09:30:00Z", 97 "price_decimal": "price_decimal" 98 }, 99 "value_bool": true, 100 "value_numeric": 1, 101 "value_trait": { 102 "created_at": "2024-01-15T09:30:00Z", 103 "display_name": "display_name", 104 "entity_type": "entity_type", 105 "hierarchy": [ 106 "hierarchy" 107 ], 108 "id": "id", 109 "trait_type": "trait_type", 110 "updated_at": "2024-01-15T09:30:00Z" 111 }, 112 "value_trait_id": "value_trait_id" 113 }, 114 "params": { 115 "key": "value" 116 } 117 }

Request

This endpoint expects an object.

feature_idstringRequired

plan_idstringRequired

value_typeenumRequired

Allowed values:

currencystringOptional

metric_periodenumOptional

Allowed values:

metric_period_month_resetenumOptional

Allowed values:

monthly_metered_price_idstringOptional

monthly_unit_priceintegerOptional

monthly_unit_price_decimalstringOptional

overage_billing_product_idstringOptional

price_behaviorstringOptional

soft_limitintegerOptional

value_boolbooleanOptional

value_numericintegerOptional

value_trait_idstringOptional

yearly_metered_price_idstringOptional

yearly_unit_priceintegerOptional

yearly_unit_price_decimalstringOptional

Response

Created

dataobject

paramsmap from strings to any

Input parameters

Create plan entitlement

Headers

Request

Response

Errors