Create plan entitlement

POST

Request

This endpoint expects an object.

feature_idstringRequired

plan_idstringRequired

value_typeenumRequired

Allowed values: booleannumerictraitunlimited

metered_monthly_price_idstringOptional

metered_yearly_price_idstringOptional

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

monthly_metered_price_idstringOptional

price_behaviorstringOptional

value_boolbooleanOptionalDefaults to false

value_numericintegerOptional

value_trait_idstringOptional

yearly_metered_price_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     "metered_monthly_price": {
25       "created_at": "2024-01-15T09:30:00Z",
26       "currency": "currency",
27       "id": "id",
28       "interval": "interval",
29       "price": 1,
30       "price_external_id": "price_external_id",
31       "price_id": "price_id",
32       "product_external_id": "product_external_id",
33       "product_id": "product_id",
34       "product_name": "product_name",
35       "updated_at": "2024-01-15T09:30:00Z",
36       "usage_type": "usage_type",
37       "meter_id": "meter_id"
38     },
39     "metered_yearly_price": {
40       "created_at": "2024-01-15T09:30:00Z",
41       "currency": "currency",
42       "id": "id",
43       "interval": "interval",
44       "price": 1,
45       "price_external_id": "price_external_id",
46       "price_id": "price_id",
47       "product_external_id": "product_external_id",
48       "product_id": "product_id",
49       "product_name": "product_name",
50       "updated_at": "2024-01-15T09:30:00Z",
51       "usage_type": "usage_type",
52       "meter_id": "meter_id"
53     },
54     "metric_period": "metric_period",
55     "metric_period_month_reset": "metric_period_month_reset",
56     "plan": {
57       "created_at": "2024-01-15T09:30:00Z",
58       "description": "description",
59       "icon": "icon",
60       "id": "id",
61       "name": "name",
62       "plan_type": "plan_type",
63       "updated_at": "2024-01-15T09:30:00Z",
64       "audience_type": "audience_type"
65     },
66     "price_behavior": "price_behavior",
67     "value_bool": true,
68     "value_numeric": 1,
69     "value_trait": {
70       "created_at": "2024-01-15T09:30:00Z",
71       "display_name": "display_name",
72       "entity_type": "entity_type",
73       "hierarchy": [
74         "hierarchy"
75       ],
76       "id": "id",
77       "trait_type": "trait_type",
78       "updated_at": "2024-01-15T09:30:00Z"
79     },
80     "value_trait_id": "value_trait_id"
81   },
82   "params": {
83     "key": "value"
84   }
85 }

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	"metered_monthly_price": {
25	"created_at": "2024-01-15T09:30:00Z",
26	"currency": "currency",
27	"id": "id",
28	"interval": "interval",
29	"price": 1,
30	"price_external_id": "price_external_id",
31	"price_id": "price_id",
32	"product_external_id": "product_external_id",
33	"product_id": "product_id",
34	"product_name": "product_name",
35	"updated_at": "2024-01-15T09:30:00Z",
36	"usage_type": "usage_type",
37	"meter_id": "meter_id"
38	},
39	"metered_yearly_price": {
40	"created_at": "2024-01-15T09:30:00Z",
41	"currency": "currency",
42	"id": "id",
43	"interval": "interval",
44	"price": 1,
45	"price_external_id": "price_external_id",
46	"price_id": "price_id",
47	"product_external_id": "product_external_id",
48	"product_id": "product_id",
49	"product_name": "product_name",
50	"updated_at": "2024-01-15T09:30:00Z",
51	"usage_type": "usage_type",
52	"meter_id": "meter_id"
53	},
54	"metric_period": "metric_period",
55	"metric_period_month_reset": "metric_period_month_reset",
56	"plan": {
57	"created_at": "2024-01-15T09:30:00Z",
58	"description": "description",
59	"icon": "icon",
60	"id": "id",
61	"name": "name",
62	"plan_type": "plan_type",
63	"updated_at": "2024-01-15T09:30:00Z",
64	"audience_type": "audience_type"
65	},
66	"price_behavior": "price_behavior",
67	"value_bool": true,
68	"value_numeric": 1,
69	"value_trait": {
70	"created_at": "2024-01-15T09:30:00Z",
71	"display_name": "display_name",
72	"entity_type": "entity_type",
73	"hierarchy": [
74	"hierarchy"
75	],
76	"id": "id",
77	"trait_type": "trait_type",
78	"updated_at": "2024-01-15T09:30:00Z"
79	},
80	"value_trait_id": "value_trait_id"
81	},
82	"params": {
83	"key": "value"
84	}
85	}