Create plan entitlement

POST

Request

This endpoint expects an object.

feature_idstringRequired

plan_idstringRequired

value_typeenumRequired

Allowed values: booleannumerictraitunlimited

metric_periodenumOptional

Allowed values: all_timebillingcurrent_monthcurrent_weekcurrent_day

metric_period_month_reset"first_of_month" or "billing_cycle"Optional

Allowed values: first_of_monthbilling_cycle

value_boolbooleanOptional

value_numericintegerOptional

value_trait_idstringOptional

Response

Created

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_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       "trait_id": "trait_id"
23     },
24     "metric_period": "metric_period",
25     "metric_period_month_reset": "metric_period_month_reset",
26     "plan": {
27       "created_at": "2024-01-15T09:30:00Z",
28       "description": "description",
29       "icon": "icon",
30       "id": "id",
31       "name": "name",
32       "plan_type": "plan_type",
33       "updated_at": "2024-01-15T09:30:00Z",
34       "audience_type": "audience_type"
35     },
36     "value_bool": true,
37     "value_numeric": 1,
38     "value_trait": {
39       "created_at": "2024-01-15T09:30:00Z",
40       "display_name": "display_name",
41       "entity_type": "entity_type",
42       "hierarchy": [
43         "hierarchy"
44       ],
45       "id": "id",
46       "trait_type": "trait_type",
47       "updated_at": "2024-01-15T09:30:00Z"
48     },
49     "value_trait_id": "value_trait_id"
50   },
51   "params": {
52     "key": "value"
53   }
54 }

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_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	"trait_id": "trait_id"
23	},
24	"metric_period": "metric_period",
25	"metric_period_month_reset": "metric_period_month_reset",
26	"plan": {
27	"created_at": "2024-01-15T09:30:00Z",
28	"description": "description",
29	"icon": "icon",
30	"id": "id",
31	"name": "name",
32	"plan_type": "plan_type",
33	"updated_at": "2024-01-15T09:30:00Z",
34	"audience_type": "audience_type"
35	},
36	"value_bool": true,
37	"value_numeric": 1,
38	"value_trait": {
39	"created_at": "2024-01-15T09:30:00Z",
40	"display_name": "display_name",
41	"entity_type": "entity_type",
42	"hierarchy": [
43	"hierarchy"
44	],
45	"id": "id",
46	"trait_type": "trait_type",
47	"updated_at": "2024-01-15T09:30:00Z"
48	},
49	"value_trait_id": "value_trait_id"
50	},
51	"params": {
52	"key": "value"
53	}
54	}