Create plan

POST

https://api.schematichq.com/plans

POST

/plans

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

Try it

1 {
2   "data": {
3     "charge_type": "string",
4     "company_count": 1,
5     "controlled_by": "string",
6     "created_at": "2024-01-15T09:30:00Z",
7     "description": "string",
8     "features": [
9       {
10         "created_at": "2024-01-15T09:30:00Z",
11         "description": "string",
12         "feature_type": "string",
13         "flags": [
14           {
15             "created_at": "2024-01-15T09:30:00Z",
16             "default_value": true,
17             "description": "string",
18             "flag_type": "string",
19             "id": "string",
20             "key": "string",
21             "name": "string",
22             "rules": [
23               {
24                 "condition_groups": [
25                   {
26                     "conditions": [
27                       {
28                         "condition_type": "string",
29                         "created_at": "2024-01-15T09:30:00Z",
30                         "environment_id": "string",
31                         "id": "string",
32                         "operator": "string",
33                         "resource_ids": [
34                           "string"
35                         ],
36                         "resources": [
37                           {
38                             "id": "string",
39                             "name": "string",
40                             "description": "string",
41                             "image_url": "string"
42                           }
43                         ],
44                         "rule_id": "string",
45                         "trait_value": "string",
46                         "updated_at": "2024-01-15T09:30:00Z",
47                         "comparison_trait": {
48                           "created_at": "2024-01-15T09:30:00Z",
49                           "display_name": "string",
50                           "entity_type": "string",
51                           "hierarchy": [
52                             "string"
53                           ],
54                           "id": "string",
55                           "trait_type": "string",
56                           "updated_at": "2024-01-15T09:30:00Z"
57                         },
58                         "comparison_trait_id": "string",
59                         "condition_group_id": "string",
60                         "event_subtype": "string",
61                         "flag_id": "string",
62                         "metric_period": "string",
63                         "metric_period_month_reset": "string",
64                         "metric_value": 1,
65                         "plan_id": "string",
66                         "trait": {
67                           "created_at": "2024-01-15T09:30:00Z",
68                           "display_name": "string",
69                           "entity_type": "string",
70                           "hierarchy": [
71                             "string"
72                           ],
73                           "id": "string",
74                           "trait_type": "string",
75                           "updated_at": "2024-01-15T09:30:00Z"
76                         },
77                         "trait_entity_type": "string",
78                         "trait_id": "string"
79                       }
80                     ],
81                     "created_at": "2024-01-15T09:30:00Z",
82                     "environment_id": "string",
83                     "id": "string",
84                     "rule_id": "string",
85                     "updated_at": "2024-01-15T09:30:00Z",
86                     "flag_id": "string",
87                     "plan_id": "string"
88                   }
89                 ],
90                 "conditions": [
91                   {
92                     "condition_type": "string",
93                     "created_at": "2024-01-15T09:30:00Z",
94                     "environment_id": "string",
95                     "id": "string",
96                     "operator": "string",
97                     "resource_ids": [
98                       "string"
99                     ],
100                     "resources": [
101                       {
102                         "id": "string",
103                         "name": "string",
104                         "description": "string",
105                         "image_url": "string"
106                       }
107                     ],
108                     "rule_id": "string",
109                     "trait_value": "string",
110                     "updated_at": "2024-01-15T09:30:00Z",
111                     "comparison_trait": {
112                       "created_at": "2024-01-15T09:30:00Z",
113                       "display_name": "string",
114                       "entity_type": "string",
115                       "hierarchy": [
116                         "string"
117                       ],
118                       "id": "string",
119                       "trait_type": "string",
120                       "updated_at": "2024-01-15T09:30:00Z"
121                     },
122                     "comparison_trait_id": "string",
123                     "condition_group_id": "string",
124                     "event_subtype": "string",
125                     "flag_id": "string",
126                     "metric_period": "string",
127                     "metric_period_month_reset": "string",
128                     "metric_value": 1,
129                     "plan_id": "string",
130                     "trait": {
131                       "created_at": "2024-01-15T09:30:00Z",
132                       "display_name": "string",
133                       "entity_type": "string",
134                       "hierarchy": [
135                         "string"
136                       ],
137                       "id": "string",
138                       "trait_type": "string",
139                       "updated_at": "2024-01-15T09:30:00Z"
140                     },
141                     "trait_entity_type": "string",
142                     "trait_id": "string"
143                   }
144                 ],
145                 "created_at": "2024-01-15T09:30:00Z",
146                 "environment_id": "string",
147                 "id": "string",
148                 "name": "string",
149                 "priority": 1,
150                 "rule_type": "string",
151                 "updated_at": "2024-01-15T09:30:00Z",
152                 "value": true,
153                 "flag_id": "string",
154                 "plan_id": "string"
155               }
156             ],
157             "updated_at": "2024-01-15T09:30:00Z",
158             "feature": {
159               "created_at": "2024-01-15T09:30:00Z",
160               "description": "string",
161               "feature_type": "string",
162               "icon": "string",
163               "id": "string",
164               "name": "string",
165               "updated_at": "2024-01-15T09:30:00Z",
166               "event_subtype": "string",
167               "lifecycle_phase": "string",
168               "maintainer_id": "string",
169               "plural_name": "string",
170               "singular_name": "string",
171               "trait_id": "string"
172             },
173             "feature_id": "string",
174             "last_checked_at": "2024-01-15T09:30:00Z",
175             "maintainer_id": "string"
176           }
177         ],
178         "icon": "string",
179         "id": "string",
180         "name": "string",
181         "plans": [
182           {
183             "id": "string",
184             "name": "string",
185             "description": "string",
186             "image_url": "string"
187           }
188         ],
189         "updated_at": "2024-01-15T09:30:00Z",
190         "event_subtype": "string",
191         "event_summary": {
192           "company_count": 1,
193           "environment_id": "string",
194           "event_count": 1,
195           "event_subtype": "string",
196           "user_count": 1,
197           "last_seen_at": "2024-01-15T09:30:00Z"
198         },
199         "lifecycle_phase": "string",
200         "maintainer_id": "string",
201         "plural_name": "string",
202         "singular_name": "string",
203         "trait": {
204           "created_at": "2024-01-15T09:30:00Z",
205           "display_name": "string",
206           "entity_type": "string",
207           "hierarchy": [
208             "string"
209           ],
210           "id": "string",
211           "trait_type": "string",
212           "updated_at": "2024-01-15T09:30:00Z"
213         },
214         "trait_id": "string"
215       }
216     ],
217     "icon": "string",
218     "id": "string",
219     "is_default": true,
220     "is_free": true,
221     "is_trialable": true,
222     "name": "string",
223     "plan_type": "string",
224     "updated_at": "2024-01-15T09:30:00Z",
225     "audience_type": "string",
226     "billing_product": {
227       "account_id": "string",
228       "created_at": "2024-01-15T09:30:00Z",
229       "environment_id": "string",
230       "external_id": "string",
231       "is_active": true,
232       "name": "string",
233       "price": 1.1,
234       "prices": [
235         {
236           "currency": "string",
237           "external_price_id": "string",
238           "id": "string",
239           "interval": "string",
240           "price": 1,
241           "scheme": "string",
242           "price_decimal": "string"
243         }
244       ],
245       "product_id": "string",
246       "quantity": 1.1,
247       "subscription_count": 1,
248       "updated_at": "2024-01-15T09:30:00Z",
249       "price_decimal": "string",
250       "currency": "string"
251     },
252     "included_credit_grants": [
253       {
254         "created_at": "2024-01-15T09:30:00Z",
255         "credit_amount": 1,
256         "credit_id": "string",
257         "credit_name": "string",
258         "id": "string",
259         "plan_id": "string",
260         "plan_name": "string",
261         "reset_cadence": "string",
262         "reset_start": "string",
263         "updated_at": "2024-01-15T09:30:00Z",
264         "credit_plural_name": "string",
265         "credit_singular_name": "string",
266         "expiry_type": "string",
267         "expiry_unit": "string",
268         "expiry_unit_count": 1,
269         "reset_type": "string"
270       }
271     ],
272     "monthly_price": {
273       "currency": "string",
274       "external_price_id": "string",
275       "id": "string",
276       "interval": "string",
277       "price": 1,
278       "scheme": "string",
279       "price_decimal": "string"
280     },
281     "one_time_price": {
282       "currency": "string",
283       "external_price_id": "string",
284       "id": "string",
285       "interval": "string",
286       "price": 1,
287       "scheme": "string",
288       "price_decimal": "string"
289     },
290     "trial_days": 1,
291     "yearly_price": {
292       "currency": "string",
293       "external_price_id": "string",
294       "id": "string",
295       "interval": "string",
296       "price": 1,
297       "scheme": "string",
298       "price_decimal": "string"
299     }
300   },
301   "params": {}
302 }

Authentication

X-Schematic-Api-Keystring

API Key authentication via header

Request

This endpoint expects an object.

descriptionstringRequired

namestringRequired

plan_typeenumRequired

Allowed values:

iconstring or nullOptional

Response

Created

dataobject

paramsobject

Input parameters

Authentication

Request

Response

Errors