Update plan

PUT

https://api.schematichq.com/plans/:plan_id

PUT

/plans/:plan_id

1 import { SchematicClient } from "@schematichq/schematic-typescript-node";
2 
3 const client = new SchematicClient({ apiKey: "YOUR_API_KEY" });
4 await client.plans.updatePlan("plan_id", {
5     name: "name"
6 });

1 {
2   "data": {
3     "charge_type": "recurring",
4     "company_count": 120,
5     "controlled_by": "stripe",
6     "created_at": "2024-01-15T09:30:00Z",
7     "description": "Access to all premium features with priority support.",
8     "features": [
9       {
10         "created_at": "2024-01-15T09:30:00Z",
11         "description": "Enables advanced analytics dashboard.",
12         "feature_type": "boolean",
13         "flags": [
14           {
15             "created_at": "2024-01-15T09:30:00Z",
16             "default_value": false,
17             "description": "Flag to enable beta analytics features.",
18             "flag_type": "boolean",
19             "id": "flag_001",
20             "key": "enable_beta_analytics",
21             "name": "Enable Beta Analytics",
22             "rules": [
23               {
24                 "condition_groups": [
25                   {
26                     "conditions": [
27                       {
28                         "condition_type": "equals",
29                         "created_at": "2024-01-15T09:30:00Z",
30                         "environment_id": "env_prod_01",
31                         "id": "cond_001",
32                         "operator": "greater_than",
33                         "resource_ids": [
34                           "res_001"
35                         ],
36                         "resources": [
37                           {
38                             "id": "res_001",
39                             "name": "Enterprise Pack",
40                             "description": "Enterprise resource pack",
41                             "image_url": "https://example.com/images/resource_enterprise.png"
42                           }
43                         ],
44                         "rule_id": "rule_001",
45                         "trait_value": "enterprise",
46                         "updated_at": "2024-01-15T09:30:00Z",
47                         "comparison_trait": {
48                           "created_at": "2024-01-15T09:30:00Z",
49                           "display_name": "Company Size",
50                           "entity_type": "company",
51                           "hierarchy": [
52                             "business",
53                             "enterprise"
54                           ],
55                           "id": "trait_company_size",
56                           "trait_type": "string",
57                           "updated_at": "2024-01-15T09:30:00Z"
58                         },
59                         "comparison_trait_id": "trait_company_size",
60                         "condition_group_id": "cond_group_001",
61                         "event_subtype": "usage",
62                         "flag_id": "flag_001",
63                         "metric_period": "monthly",
64                         "metric_period_month_reset": "first_of_month",
65                         "metric_value": 100,
66                         "trait": {
67                           "created_at": "2024-01-15T09:30:00Z",
68                           "display_name": "Company Size",
69                           "entity_type": "company",
70                           "hierarchy": [
71                             "business",
72                             "enterprise"
73                           ],
74                           "id": "trait_company_size",
75                           "trait_type": "string",
76                           "updated_at": "2024-01-15T09:30:00Z"
77                         },
78                         "trait_entity_type": "company",
79                         "trait_id": "trait_company_size"
80                       }
81                     ],
82                     "created_at": "2024-01-15T09:30:00Z",
83                     "environment_id": "env_prod_01",
84                     "id": "cond_group_001",
85                     "rule_id": "rule_001",
86                     "updated_at": "2024-01-15T09:30:00Z",
87                     "flag_id": "flag_001"
88                   }
89                 ],
90                 "conditions": [
91                   {
92                     "condition_type": "equals",
93                     "created_at": "2024-01-15T09:30:00Z",
94                     "environment_id": "env_prod_01",
95                     "id": "cond_002",
96                     "operator": "greater_than",
97                     "resource_ids": [
98                       "res_001"
99                     ],
100                     "resources": [
101                       {
102                         "id": "res_001",
103                         "name": "Enterprise Pack",
104                         "description": "Enterprise resource pack",
105                         "image_url": "https://example.com/images/resource_enterprise.png"
106                       }
107                     ],
108                     "rule_id": "rule_001",
109                     "trait_value": "enterprise",
110                     "updated_at": "2024-01-15T09:30:00Z",
111                     "comparison_trait": {
112                       "created_at": "2024-01-15T09:30:00Z",
113                       "display_name": "Company Size",
114                       "entity_type": "company",
115                       "hierarchy": [
116                         "business",
117                         "enterprise"
118                       ],
119                       "id": "trait_company_size",
120                       "trait_type": "string",
121                       "updated_at": "2024-01-15T09:30:00Z"
122                     },
123                     "comparison_trait_id": "trait_company_size",
124                     "condition_group_id": "cond_group_001",
125                     "event_subtype": "usage",
126                     "flag_id": "flag_001",
127                     "metric_period": "monthly",
128                     "metric_period_month_reset": "first_of_month",
129                     "metric_value": 100,
130                     "trait": {
131                       "created_at": "2024-01-15T09:30:00Z",
132                       "display_name": "Company Size",
133                       "entity_type": "company",
134                       "hierarchy": [
135                         "business",
136                         "enterprise"
137                       ],
138                       "id": "trait_company_size",
139                       "trait_type": "string",
140                       "updated_at": "2024-01-15T09:30:00Z"
141                     },
142                     "trait_entity_type": "company",
143                     "trait_id": "trait_company_size"
144                   }
145                 ],
146                 "created_at": "2024-01-15T09:30:00Z",
147                 "environment_id": "env_prod_01",
148                 "id": "rule_001",
149                 "name": "Enterprise Access Rule",
150                 "priority": 1,
151                 "rule_type": "access_control",
152                 "updated_at": "2024-01-15T09:30:00Z",
153                 "value": true,
154                 "flag_id": "flag_001"
155               }
156             ],
157             "updated_at": "2024-01-15T09:30:00Z",
158             "feature": {
159               "created_at": "2024-01-15T09:30:00Z",
160               "description": "Beta analytics feature flag.",
161               "feature_type": "boolean",
162               "icon": "analytics_icon",
163               "id": "feat_analytics_beta",
164               "name": "Beta Analytics",
165               "updated_at": "2024-01-15T09:30:00Z",
166               "event_subtype": "beta",
167               "lifecycle_phase": "beta",
168               "maintainer_id": "maint_001",
169               "plural_name": "Beta Analytics Features",
170               "singular_name": "Beta Analytics Feature",
171               "trait_id": "trait_analytics"
172             },
173             "feature_id": "feat_analytics_beta",
174             "last_checked_at": "2024-04-10T12:00:00Z",
175             "maintainer_id": "maint_001"
176           }
177         ],
178         "icon": "analytics_icon",
179         "id": "feat_analytics",
180         "name": "Advanced Analytics",
181         "plans": [
182           {
183             "id": "plan_001",
184             "name": "Premium Plan",
185             "description": "Premium Plan",
186             "image_url": "https://example.com/images/premium_plan.png"
187           }
188         ],
189         "updated_at": "2024-01-15T09:30:00Z",
190         "event_subtype": "usage",
191         "event_summary": {
192           "company_count": 100,
193           "environment_id": "env_prod_01",
194           "event_count": 5000,
195           "event_subtype": "usage",
196           "user_count": 450,
197           "last_seen_at": "2024-04-10T12:00:00Z"
198         },
199         "lifecycle_phase": "beta",
200         "maintainer_id": "maint_001",
201         "plural_name": "Advanced Analytics Features",
202         "singular_name": "Advanced Analytics Feature",
203         "trait": {
204           "created_at": "2024-01-15T09:30:00Z",
205           "display_name": "Analytics Enabled",
206           "entity_type": "company",
207           "hierarchy": [
208             "feature",
209             "analytics"
210           ],
211           "id": "trait_analytics",
212           "trait_type": "boolean",
213           "updated_at": "2024-01-15T09:30:00Z"
214         },
215         "trait_id": "trait_analytics"
216       }
217     ],
218     "icon": "premium_icon",
219     "id": "plan_001",
220     "is_free": false,
221     "is_trialable": true,
222     "name": "Premium Plan",
223     "plan_type": "plan",
224     "updated_at": "2024-04-10T12:00:00Z",
225     "versions": [
226       {
227         "created_at": "2024-01-15T09:30:00Z",
228         "description": "Initial release of Premium Plan",
229         "environment_id": "env_prod_01",
230         "icon": "premium_icon",
231         "id": "version_001",
232         "name": "Premium Plan v1",
233         "plan_type": "plan",
234         "status": "published",
235         "updated_at": "2024-04-10T12:00:00Z",
236         "version": 1,
237         "original_plan_id": "plan_001"
238       }
239     ],
240     "is_default": false,
241     "billing_product": {
242       "account_id": "acc_987654321",
243       "created_at": "2024-01-15T09:30:00Z",
244       "environment_id": "env_prod_01",
245       "external_id": "prod_ext_12345",
246       "is_active": true,
247       "name": "Premium Subscription",
248       "price": 99.99,
249       "prices": [
250         {
251           "currency": "USD",
252           "external_price_id": "price_ext_001",
253           "id": "price_001",
254           "interval": "month",
255           "price": 9999,
256           "provider_type": "stripe",
257           "scheme": "per_unit",
258           "price_decimal": "99.99"
259         }
260       ],
261       "product_id": "prod_001",
262       "provider_type": "stripe",
263       "quantity": 1,
264       "subscription_count": 150,
265       "updated_at": "2024-01-15T09:30:00Z",
266       "price_decimal": "99.99",
267       "currency": "USD"
268     },
269     "included_credit_grants": [
270       {
271         "auto_topup_enabled": true,
272         "created_at": "2024-01-15T09:30:00Z",
273         "credit_amount": 500,
274         "credit_id": "credit_001",
275         "credit_name": "API Calls",
276         "id": "credit_grant_001",
277         "plan_id": "plan_001",
278         "reset_cadence": "monthly",
279         "reset_start": "billing_period",
280         "updated_at": "2024-01-15T09:30:00Z",
281         "plan_name": "Premium Plan",
282         "auto_topup_amount": 100,
283         "auto_topup_amount_type": "credits",
284         "auto_topup_expiry_type": "duration",
285         "auto_topup_expiry_unit": "billing_periods",
286         "auto_topup_expiry_unit_count": 3,
287         "auto_topup_threshold_percent": 20,
288         "credit_plural_name": "API Calls",
289         "credit_singular_name": "API Call",
290         "expiry_type": "duration",
291         "expiry_unit": "billing_periods",
292         "expiry_unit_count": 6,
293         "plan": {
294           "id": "plan_001",
295           "name": "Premium Plan",
296           "description": "Premium Plan",
297           "image_url": "https://example.com/images/premium_plan.png"
298         },
299         "reset_type": "no_reset"
300       }
301     ],
302     "monthly_price": {
303       "currency": "USD",
304       "external_price_id": "price_monthly_001",
305       "id": "price_monthly_001",
306       "interval": "month",
307       "price": 9999,
308       "provider_type": "stripe",
309       "scheme": "per_unit",
310       "price_decimal": "99.99"
311     },
312     "one_time_price": {
313       "currency": "USD",
314       "external_price_id": "price_onetime_001",
315       "id": "price_onetime_001",
316       "interval": "one-time",
317       "price": 19999,
318       "provider_type": "stripe",
319       "scheme": "per_unit",
320       "price_decimal": "199.99"
321     },
322     "trial_days": 14,
323     "yearly_price": {
324       "currency": "USD",
325       "external_price_id": "price_yearly_001",
326       "id": "price_yearly_001",
327       "interval": "year",
328       "price": 99999,
329       "provider_type": "stripe",
330       "scheme": "per_unit",
331       "price_decimal": "999.99"
332     },
333     "audience_type": "enterprise"
334   },
335   "params": {}
336 }

Authentication

X-Schematic-Api-Keystring

API Key authentication via header

Path parameters

plan_idstringRequired

plan_id

Request

This endpoint expects an object.

namestringRequired1-256 characters

descriptionstring or nullOptional0-1024 characters

iconstring or nullOptional<=64 characters

Response

dataobject

paramsobject

Input parameters

Authentication

Path parameters

Request

Response

Errors