Update plan

PUT

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

PUT

/plans/:plan_id

1 import { SchematicClient } from "@schematichq/schematic-typescript-node";
2 
3 async function main() {
4     const client = new SchematicClient({
5         apiKey: "YOUR_API_KEY_HERE",
6     });
7     await client.plans.updatePlan("plan_id", {
8         name: "string",
9     });
10 }
11 main();

1 {
2   "data": {
3     "charge_type": "free",
4     "company_count": 1,
5     "controlled_by": "schematic",
6     "created_at": "2024-01-15T09:30:00Z",
7     "currency_prices": [
8       {
9         "currency": "string",
10         "monthly_price": {
11           "currency": "string",
12           "external_price_id": "string",
13           "id": "string",
14           "interval": "day",
15           "price": 1,
16           "provider_type": "schematic",
17           "scheme": "per_unit",
18           "price_decimal": "string"
19         },
20         "one_time_price": {
21           "currency": "string",
22           "external_price_id": "string",
23           "id": "string",
24           "interval": "day",
25           "price": 1,
26           "provider_type": "schematic",
27           "scheme": "per_unit",
28           "price_decimal": "string"
29         },
30         "yearly_price": {
31           "currency": "string",
32           "external_price_id": "string",
33           "id": "string",
34           "interval": "day",
35           "price": 1,
36           "provider_type": "schematic",
37           "scheme": "per_unit",
38           "price_decimal": "string"
39         }
40       }
41     ],
42     "description": "string",
43     "features": [
44       {
45         "created_at": "2024-01-15T09:30:00Z",
46         "description": "string",
47         "feature_type": "boolean",
48         "flags": [
49           {
50             "created_at": "2024-01-15T09:30:00Z",
51             "default_value": true,
52             "description": "string",
53             "flag_type": "boolean",
54             "id": "string",
55             "key": "string",
56             "name": "string",
57             "rules": [
58               {
59                 "condition_groups": [
60                   {
61                     "conditions": [
62                       {
63                         "condition_type": "string",
64                         "created_at": "2024-01-15T09:30:00Z",
65                         "environment_id": "string",
66                         "id": "string",
67                         "operator": "string",
68                         "resource_ids": [
69                           "string"
70                         ],
71                         "resources": [
72                           {
73                             "id": "string",
74                             "name": "string",
75                             "description": "string",
76                             "image_url": "string"
77                           }
78                         ],
79                         "rule_id": "string",
80                         "trait_value": "string",
81                         "updated_at": "2024-01-15T09:30:00Z",
82                         "comparison_trait": {
83                           "created_at": "2024-01-15T09:30:00Z",
84                           "display_name": "string",
85                           "entity_type": "company",
86                           "hierarchy": [
87                             "string"
88                           ],
89                           "id": "string",
90                           "trait_type": "boolean",
91                           "updated_at": "2024-01-15T09:30:00Z"
92                         },
93                         "comparison_trait_id": "string",
94                         "condition_group_id": "string",
95                         "event_subtype": "string",
96                         "flag_id": "string",
97                         "metric_period": "string",
98                         "metric_period_month_reset": "string",
99                         "metric_value": 1,
100                         "trait": {
101                           "created_at": "2024-01-15T09:30:00Z",
102                           "display_name": "string",
103                           "entity_type": "company",
104                           "hierarchy": [
105                             "string"
106                           ],
107                           "id": "string",
108                           "trait_type": "boolean",
109                           "updated_at": "2024-01-15T09:30:00Z"
110                         },
111                         "trait_entity_type": "company",
112                         "trait_id": "string"
113                       }
114                     ],
115                     "created_at": "2024-01-15T09:30:00Z",
116                     "environment_id": "string",
117                     "id": "string",
118                     "rule_id": "string",
119                     "updated_at": "2024-01-15T09:30:00Z",
120                     "flag_id": "string"
121                   }
122                 ],
123                 "conditions": [
124                   {
125                     "condition_type": "string",
126                     "created_at": "2024-01-15T09:30:00Z",
127                     "environment_id": "string",
128                     "id": "string",
129                     "operator": "string",
130                     "resource_ids": [
131                       "string"
132                     ],
133                     "resources": [
134                       {
135                         "id": "string",
136                         "name": "string",
137                         "description": "string",
138                         "image_url": "string"
139                       }
140                     ],
141                     "rule_id": "string",
142                     "trait_value": "string",
143                     "updated_at": "2024-01-15T09:30:00Z",
144                     "comparison_trait": {
145                       "created_at": "2024-01-15T09:30:00Z",
146                       "display_name": "string",
147                       "entity_type": "company",
148                       "hierarchy": [
149                         "string"
150                       ],
151                       "id": "string",
152                       "trait_type": "boolean",
153                       "updated_at": "2024-01-15T09:30:00Z"
154                     },
155                     "comparison_trait_id": "string",
156                     "condition_group_id": "string",
157                     "event_subtype": "string",
158                     "flag_id": "string",
159                     "metric_period": "string",
160                     "metric_period_month_reset": "string",
161                     "metric_value": 1,
162                     "trait": {
163                       "created_at": "2024-01-15T09:30:00Z",
164                       "display_name": "string",
165                       "entity_type": "company",
166                       "hierarchy": [
167                         "string"
168                       ],
169                       "id": "string",
170                       "trait_type": "boolean",
171                       "updated_at": "2024-01-15T09:30:00Z"
172                     },
173                     "trait_entity_type": "company",
174                     "trait_id": "string"
175                   }
176                 ],
177                 "created_at": "2024-01-15T09:30:00Z",
178                 "environment_id": "string",
179                 "id": "string",
180                 "name": "string",
181                 "priority": 1,
182                 "rule_type": "string",
183                 "updated_at": "2024-01-15T09:30:00Z",
184                 "value": true,
185                 "flag_id": "string"
186               }
187             ],
188             "updated_at": "2024-01-15T09:30:00Z",
189             "feature": {
190               "created_at": "2024-01-15T09:30:00Z",
191               "description": "string",
192               "feature_type": "boolean",
193               "icon": "string",
194               "id": "string",
195               "name": "string",
196               "updated_at": "2024-01-15T09:30:00Z",
197               "event_subtype": "string",
198               "lifecycle_phase": "add_on",
199               "maintainer_id": "string",
200               "plural_name": "string",
201               "singular_name": "string",
202               "trait_id": "string"
203             },
204             "feature_id": "string",
205             "last_checked_at": "2024-01-15T09:30:00Z",
206             "maintainer_id": "string"
207           }
208         ],
209         "icon": "string",
210         "id": "string",
211         "name": "string",
212         "plans": [
213           {
214             "id": "string",
215             "name": "string",
216             "description": "string",
217             "image_url": "string"
218           }
219         ],
220         "updated_at": "2024-01-15T09:30:00Z",
221         "event_subtype": "string",
222         "event_summary": {
223           "company_count": 1,
224           "environment_id": "string",
225           "event_count": 1,
226           "event_subtype": "string",
227           "user_count": 1,
228           "last_seen_at": "2024-01-15T09:30:00Z"
229         },
230         "lifecycle_phase": "add_on",
231         "maintainer_id": "string",
232         "plural_name": "string",
233         "singular_name": "string",
234         "trait": {
235           "created_at": "2024-01-15T09:30:00Z",
236           "display_name": "string",
237           "entity_type": "company",
238           "hierarchy": [
239             "string"
240           ],
241           "id": "string",
242           "trait_type": "boolean",
243           "updated_at": "2024-01-15T09:30:00Z"
244         },
245         "trait_id": "string"
246       }
247     ],
248     "icon": "string",
249     "id": "string",
250     "is_free": true,
251     "is_trialable": true,
252     "name": "string",
253     "plan_type": "plan",
254     "updated_at": "2024-01-15T09:30:00Z",
255     "versions": [
256       {
257         "created_at": "2024-01-15T09:30:00Z",
258         "description": "string",
259         "environment_id": "string",
260         "icon": "string",
261         "id": "string",
262         "name": "string",
263         "plan_type": "plan",
264         "status": "published",
265         "updated_at": "2024-01-15T09:30:00Z",
266         "version": 1,
267         "original_plan_id": "string"
268       }
269     ],
270     "is_default": true,
271     "active_version": {
272       "created_at": "2024-01-15T09:30:00Z",
273       "description": "string",
274       "environment_id": "string",
275       "icon": "string",
276       "id": "string",
277       "name": "string",
278       "plan_type": "plan",
279       "status": "published",
280       "updated_at": "2024-01-15T09:30:00Z",
281       "version": 1,
282       "original_plan_id": "string"
283     },
284     "billing_product": {
285       "account_id": "string",
286       "created_at": "2024-01-15T09:30:00Z",
287       "environment_id": "string",
288       "external_id": "string",
289       "is_active": true,
290       "name": "string",
291       "price": 1.1,
292       "prices": [
293         {
294           "currency": "string",
295           "external_price_id": "string",
296           "id": "string",
297           "interval": "day",
298           "price": 1,
299           "provider_type": "schematic",
300           "scheme": "per_unit",
301           "price_decimal": "string"
302         }
303       ],
304       "product_id": "string",
305       "provider_type": "schematic",
306       "quantity": 1.1,
307       "subscription_count": 1,
308       "updated_at": "2024-01-15T09:30:00Z",
309       "price_decimal": "string",
310       "currency": "string"
311     },
312     "draft_version": {
313       "created_at": "2024-01-15T09:30:00Z",
314       "description": "string",
315       "environment_id": "string",
316       "icon": "string",
317       "id": "string",
318       "name": "string",
319       "plan_type": "plan",
320       "status": "published",
321       "updated_at": "2024-01-15T09:30:00Z",
322       "version": 1,
323       "original_plan_id": "string"
324     },
325     "included_credit_grants": [
326       {
327         "auto_topup_enabled": true,
328         "created_at": "2024-01-15T09:30:00Z",
329         "credit_amount": 1,
330         "credit_id": "string",
331         "id": "string",
332         "plan_id": "string",
333         "updated_at": "2024-01-15T09:30:00Z",
334         "credit_name": "string",
335         "plan_name": "string",
336         "auto_topup_amount": 1,
337         "auto_topup_amount_type": "string",
338         "auto_topup_expiry_type": "duration",
339         "auto_topup_expiry_unit": "billing_periods",
340         "auto_topup_expiry_unit_count": 1,
341         "auto_topup_threshold_percent": 1,
342         "credit": {
343           "burn_strategy": "expiration_priority",
344           "cost_editable": true,
345           "created_at": "2024-01-15T09:30:00Z",
346           "currency_prices": [
347             {
348               "currency": "string",
349               "price": {
350                 "currency": "string",
351                 "external_price_id": "string",
352                 "id": "string",
353                 "interval": "day",
354                 "price": 1,
355                 "provider_type": "schematic",
356                 "scheme": "per_unit",
357                 "price_decimal": "string"
358               }
359             }
360           ],
361           "default_expiry_unit": "billing_periods",
362           "default_rollover_policy": "expire",
363           "description": "string",
364           "id": "string",
365           "name": "string",
366           "updated_at": "2024-01-15T09:30:00Z",
367           "default_expiry_unit_count": 1,
368           "icon": "string",
369           "plural_name": "string",
370           "price": {
371             "currency": "string",
372             "external_price_id": "string",
373             "id": "string",
374             "interval": "day",
375             "price": 1,
376             "provider_type": "schematic",
377             "scheme": "per_unit",
378             "price_decimal": "string"
379           },
380           "product": {
381             "account_id": "string",
382             "created_at": "2024-01-15T09:30:00Z",
383             "environment_id": "string",
384             "external_id": "string",
385             "is_active": true,
386             "name": "string",
387             "price": 1.1,
388             "product_id": "string",
389             "provider_type": "schematic",
390             "quantity": 1.1,
391             "updated_at": "2024-01-15T09:30:00Z",
392             "price_decimal": "string",
393             "currency": "string"
394           },
395           "singular_name": "string"
396         },
397         "expiry_type": "duration",
398         "expiry_unit": "billing_periods",
399         "expiry_unit_count": 1,
400         "plan": {
401           "id": "string",
402           "name": "string",
403           "description": "string",
404           "image_url": "string"
405         },
406         "plan_version_id": "string",
407         "reset_cadence": "daily",
408         "reset_start": "billing_period",
409         "reset_type": "no_reset",
410         "credit_plural_name": "string",
411         "credit_singular_name": "string"
412       }
413     ],
414     "monthly_price": {
415       "currency": "string",
416       "external_price_id": "string",
417       "id": "string",
418       "interval": "day",
419       "price": 1,
420       "provider_type": "schematic",
421       "scheme": "per_unit",
422       "price_decimal": "string"
423     },
424     "one_time_price": {
425       "currency": "string",
426       "external_price_id": "string",
427       "id": "string",
428       "interval": "day",
429       "price": 1,
430       "provider_type": "schematic",
431       "scheme": "per_unit",
432       "price_decimal": "string"
433     },
434     "trial_days": 1,
435     "yearly_price": {
436       "currency": "string",
437       "external_price_id": "string",
438       "id": "string",
439       "interval": "day",
440       "price": 1,
441       "provider_type": "schematic",
442       "scheme": "per_unit",
443       "price_decimal": "string"
444     },
445     "audience_type": "string"
446   },
447   "params": {}
448 }

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

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error