Create plan entitlement

POST

Request

This endpoint expects an object.

feature_idstringRequired

plan_idstringRequired

value_typeenumRequired

Allowed values: booleannumerictraitunlimited

metric_periodenumOptional

Allowed values: current_monthcurrent_weekcurrent_day

value_boolbooleanOptional

value_numericintegerOptional

value_trait_idstringOptional

Response

This endpoint returns an object

dataobject

paramsmap from strings to any

Input parameters

POST

1 curl -X POST https://api.schematichq.com/plan-entitlements \
2      -H "X-Schematic-Api-Key: <apiKey>" \
3      -H "Content-Type: application/json" \
4      -d '{
5   "feature_id": "feature_id",
6   "plan_id": "plan_id",
7   "value_type": "boolean"
8 }'

200Successful

1 {
2   "data": {
3     "created_at": "2024-01-15T09:30:00Z",
4     "environment_id": "environment_id",
5     "feature": {
6       "created_at": "2024-01-15T09:30:00Z",
7       "description": "description",
8       "event_subtype": "event_subtype",
9       "feature_type": "feature_type",
10       "icon": "icon",
11       "id": "id",
12       "lifecycle_phase": "lifecycle_phase",
13       "maintainer_id": "maintainer_id",
14       "name": "name",
15       "trait_id": "trait_id",
16       "updated_at": "2024-01-15T09:30:00Z"
17     },
18     "feature_id": "feature_id",
19     "id": "id",
20     "metric_period": "metric_period",
21     "plan": {
22       "audience_type": "audience_type",
23       "created_at": "2024-01-15T09:30:00Z",
24       "description": "description",
25       "icon": "icon",
26       "id": "id",
27       "name": "name",
28       "plan_type": "plan_type",
29       "updated_at": "2024-01-15T09:30:00Z"
30     },
31     "plan_id": "plan_id",
32     "rule_id": "rule_id",
33     "updated_at": "2024-01-15T09:30:00Z",
34     "value_bool": true,
35     "value_numeric": 1,
36     "value_trait": {
37       "created_at": "2024-01-15T09:30:00Z",
38       "display_name": "display_name",
39       "entity_type": "entity_type",
40       "hierarchy": [
41         "hierarchy"
42       ],
43       "id": "id",
44       "trait_type": "trait_type",
45       "updated_at": "2024-01-15T09:30:00Z"
46     },
47     "value_trait_id": "value_trait_id",
48     "value_type": "value_type"
49   },
50   "params": {
51     "key": "value"
52   }
53 }

Built with

1	curl -X POST https://api.schematichq.com/plan-entitlements \
2	-H "X-Schematic-Api-Key: <apiKey>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"feature_id": "feature_id",
6	"plan_id": "plan_id",
7	"value_type": "boolean"
8	}'

1	{
2	"data": {
3	"created_at": "2024-01-15T09:30:00Z",
4	"environment_id": "environment_id",
5	"feature": {
6	"created_at": "2024-01-15T09:30:00Z",
7	"description": "description",
8	"event_subtype": "event_subtype",
9	"feature_type": "feature_type",
10	"icon": "icon",
11	"id": "id",
12	"lifecycle_phase": "lifecycle_phase",
13	"maintainer_id": "maintainer_id",
14	"name": "name",
15	"trait_id": "trait_id",
16	"updated_at": "2024-01-15T09:30:00Z"
17	},
18	"feature_id": "feature_id",
19	"id": "id",
20	"metric_period": "metric_period",
21	"plan": {
22	"audience_type": "audience_type",
23	"created_at": "2024-01-15T09:30:00Z",
24	"description": "description",
25	"icon": "icon",
26	"id": "id",
27	"name": "name",
28	"plan_type": "plan_type",
29	"updated_at": "2024-01-15T09:30:00Z"
30	},
31	"plan_id": "plan_id",
32	"rule_id": "rule_id",
33	"updated_at": "2024-01-15T09:30:00Z",
34	"value_bool": true,
35	"value_numeric": 1,
36	"value_trait": {
37	"created_at": "2024-01-15T09:30:00Z",
38	"display_name": "display_name",
39	"entity_type": "entity_type",
40	"hierarchy": [
41	"hierarchy"
42	],
43	"id": "id",
44	"trait_type": "trait_type",
45	"updated_at": "2024-01-15T09:30:00Z"
46	},
47	"value_trait_id": "value_trait_id",
48	"value_type": "value_type"
49	},
50	"params": {
51	"key": "value"
52	}
53	}