Update plan entitlement

PUT

Path parameters

plan_entitlement_idstringRequired

plan_entitlement_id

Request

This endpoint expects an object.

value_typeenumRequired

Allowed values: booleannumerictraitunlimited

metric_periodenumOptional

Allowed values: all_timecurrent_monthcurrent_weekcurrent_day

metric_period_month_resetenumOptional

Allowed values: first_of_monthbilling_cycle

monthly_metered_price_idstringOptional

price_behaviorstringOptional

value_boolbooleanOptional

value_numericintegerOptional

value_trait_idstringOptional

yearly_metered_price_idstringOptional

Response

dataobject

paramsmap from strings to any

Input parameters

Errors

PUT

1 import { SchematicClient, Schematic } from "@schematichq/schematic-typescript-node";
2 
3 const client = new SchematicClient({ apiKey: "YOUR_API_KEY" });
4 await client.entitlements.updatePlanEntitlement("plan_entitlement_id", {
5     valueType: "boolean"
6 });

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

Built with

1	import { SchematicClient, Schematic } from "@schematichq/schematic-typescript-node";
2
3	const client = new SchematicClient({ apiKey: "YOUR_API_KEY" });
4	await client.entitlements.updatePlanEntitlement("plan_entitlement_id", {
5	valueType: "boolean"
6	});

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