Update plan entitlement

PUT

https://api.schematichq.com/plan-entitlements/:plan_entitlement_id

PUT

/plan-entitlements/:plan_entitlement_id

1 import { SchematicClient } 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 });

Try it

1 {
2   "data": {
3     "created_at": "2024-01-15T09:30:00Z",
4     "environment_id": "string",
5     "feature_id": "string",
6     "id": "string",
7     "plan_id": "string",
8     "rule_id": "string",
9     "updated_at": "2024-01-15T09:30:00Z",
10     "value_type": "string",
11     "consumption_rate": 1.1,
12     "feature": {
13       "created_at": "2024-01-15T09:30:00Z",
14       "description": "string",
15       "feature_type": "string",
16       "icon": "string",
17       "id": "string",
18       "name": "string",
19       "updated_at": "2024-01-15T09:30:00Z",
20       "event_subtype": "string",
21       "lifecycle_phase": "string",
22       "maintainer_id": "string",
23       "plural_name": "string",
24       "singular_name": "string",
25       "trait_id": "string"
26     },
27     "metered_monthly_price": {
28       "billing_scheme": "string",
29       "created_at": "2024-01-15T09:30:00Z",
30       "currency": "string",
31       "id": "string",
32       "interval": "string",
33       "is_active": true,
34       "package_size": 1,
35       "price": 1,
36       "price_external_id": "string",
37       "price_id": "string",
38       "price_tier": [
39         {
40           "flat_amount": 1,
41           "per_unit_price": 1,
42           "per_unit_price_decimal": "string",
43           "up_to": 1
44         }
45       ],
46       "product_external_id": "string",
47       "product_id": "string",
48       "product_name": "string",
49       "updated_at": "2024-01-15T09:30:00Z",
50       "usage_type": "string",
51       "meter_event_name": "string",
52       "meter_event_payload_key": "string",
53       "meter_id": "string",
54       "price_decimal": "string",
55       "tiers_mode": "string"
56     },
57     "metered_yearly_price": {
58       "billing_scheme": "string",
59       "created_at": "2024-01-15T09:30:00Z",
60       "currency": "string",
61       "id": "string",
62       "interval": "string",
63       "is_active": true,
64       "package_size": 1,
65       "price": 1,
66       "price_external_id": "string",
67       "price_id": "string",
68       "price_tier": [
69         {
70           "flat_amount": 1,
71           "per_unit_price": 1,
72           "per_unit_price_decimal": "string",
73           "up_to": 1
74         }
75       ],
76       "product_external_id": "string",
77       "product_id": "string",
78       "product_name": "string",
79       "updated_at": "2024-01-15T09:30:00Z",
80       "usage_type": "string",
81       "meter_event_name": "string",
82       "meter_event_payload_key": "string",
83       "meter_id": "string",
84       "price_decimal": "string",
85       "tiers_mode": "string"
86     },
87     "metric_period": "string",
88     "metric_period_month_reset": "string",
89     "plan": {
90       "created_at": "2024-01-15T09:30:00Z",
91       "description": "string",
92       "icon": "string",
93       "id": "string",
94       "name": "string",
95       "plan_type": "string",
96       "updated_at": "2024-01-15T09:30:00Z",
97       "audience_type": "string"
98     },
99     "price_behavior": "string",
100     "rule_id_usage_exceeded": "string",
101     "soft_limit": 1,
102     "usage_based_product": {
103       "account_id": "string",
104       "created_at": "2024-01-15T09:30:00Z",
105       "currency": "string",
106       "environment_id": "string",
107       "external_id": "string",
108       "is_active": true,
109       "name": "string",
110       "price": 1.1,
111       "product_id": "string",
112       "quantity": 1.1,
113       "updated_at": "2024-01-15T09:30:00Z",
114       "price_decimal": "string"
115     },
116     "value_bool": true,
117     "value_credit": {
118       "burn_strategy": "string",
119       "created_at": "2024-01-15T09:30:00Z",
120       "default_expiry_unit": "string",
121       "default_rollover_policy": "string",
122       "description": "string",
123       "id": "string",
124       "name": "string",
125       "updated_at": "2024-01-15T09:30:00Z",
126       "default_expiry_unit_count": 1,
127       "icon": "string",
128       "plural_name": "string",
129       "price": {
130         "currency": "string",
131         "external_price_id": "string",
132         "id": "string",
133         "interval": "string",
134         "price": 1,
135         "scheme": "string",
136         "price_decimal": "string"
137       },
138       "product": {
139         "account_id": "string",
140         "created_at": "2024-01-15T09:30:00Z",
141         "currency": "string",
142         "environment_id": "string",
143         "external_id": "string",
144         "is_active": true,
145         "name": "string",
146         "price": 1.1,
147         "product_id": "string",
148         "quantity": 1.1,
149         "updated_at": "2024-01-15T09:30:00Z",
150         "price_decimal": "string"
151       },
152       "singular_name": "string"
153     },
154     "value_numeric": 1,
155     "value_trait": {
156       "created_at": "2024-01-15T09:30:00Z",
157       "display_name": "string",
158       "entity_type": "string",
159       "hierarchy": [
160         "string"
161       ],
162       "id": "string",
163       "trait_type": "string",
164       "updated_at": "2024-01-15T09:30:00Z"
165     },
166     "value_trait_id": "string"
167   },
168   "params": {}
169 }

Path parameters

plan_entitlement_idstringRequired

plan_entitlement_id

Request

This endpoint expects an object.

value_typeenumRequired

Allowed values:

billing_product_idstring or nullOptional

credit_consumption_ratedouble or nullOptional

currencystring or nullOptional

metric_periodenum or nullOptional

Allowed values:

metric_period_month_resetenum or nullOptional

Allowed values:

monthly_price_tierslist of objects or nullOptional

monthly_unit_priceinteger or nullOptional

monthly_unit_price_decimalstring or nullOptional

price_behaviorenum or nullOptional

Allowed values:

soft_limitinteger or nullOptional

tier_modestring or nullOptional

value_boolboolean or nullOptional

value_credit_idstring or nullOptional

value_numericinteger or nullOptional

value_trait_idstring or nullOptional

yearly_price_tierslist of objects or nullOptional

yearly_unit_priceinteger or nullOptional

yearly_unit_price_decimalstring or nullOptional

monthly_metered_price_idstring or nullOptionalDeprecated

overage_billing_product_idstring or nullOptionalDeprecated

price_tierslist of objects or nullOptionalDeprecated

Use MonthlyPriceTiers or YearlyPriceTiers instead

yearly_metered_price_idstring or nullOptionalDeprecated

Response

dataobject

paramsobject

Input parameters

Update plan entitlement

Path parameters

Headers

Request

Response

Errors