Create plan

POST

https://api.schematichq.com/plans

POST

/plans

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.createPlan({
8         description: "Premium subscription plan with full access to all features.",
9         name: "Premium Plan",
10         planType: "plan",
11     });
12 }
13 main();

1 {
2   "data": {
3     "charge_type": "recurring",
4     "company_count": 150,
5     "controlled_by": "orb",
6     "created_at": "2024-01-15T09:30:00Z",
7     "currency_prices": [
8       {
9         "currency": "USD",
10         "monthly_price": {
11           "currency": "USD",
12           "external_price_id": "price_ext_001",
13           "id": "price_001",
14           "interval": "month",
15           "price": 2999,
16           "provider_type": "orb",
17           "scheme": "per_unit",
18           "price_decimal": "29.99"
19         },
20         "one_time_price": {
21           "currency": "USD",
22           "external_price_id": "price_ext_002",
23           "id": "price_002",
24           "interval": "one-time",
25           "price": 2999,
26           "provider_type": "orb",
27           "scheme": "per_unit",
28           "price_decimal": "29.99"
29         },
30         "yearly_price": {
31           "currency": "USD",
32           "external_price_id": "price_ext_003",
33           "id": "price_003",
34           "interval": "year",
35           "price": 29999,
36           "provider_type": "orb",
37           "scheme": "per_unit",
38           "price_decimal": "299.99"
39         }
40       }
41     ],
42     "description": "Premium subscription plan with full access to all features.",
43     "features": [
44       {
45         "created_at": "2024-01-15T09:30:00Z",
46         "description": "Access to advanced analytics dashboard.",
47         "feature_type": "boolean",
48         "flags": [
49           {
50             "created_at": "2024-01-15T09:30:00Z",
51             "default_value": true,
52             "description": "Enable advanced analytics feature flag.",
53             "flag_type": "boolean",
54             "id": "flag_001",
55             "key": "enable_advanced_analytics",
56             "name": "Enable Advanced Analytics",
57             "rules": [
58               {
59                 "condition_groups": [
60                   {
61                     "conditions": [
62                       {
63                         "condition_type": "equals",
64                         "created_at": "2024-01-15T09:30:00Z",
65                         "environment_id": "env_1234567890abcdef",
66                         "id": "cond_001",
67                         "operator": "equals",
68                         "resource_ids": [
69                           "resource_001"
70                         ],
71                         "resources": [
72                           {
73                             "id": "resource_001",
74                             "name": "Enterprise Resource",
75                             "description": "Enterprise customer resource",
76                             "image_url": "https://example.com/images/resource_001.png"
77                           }
78                         ],
79                         "rule_id": "rule_001",
80                         "trait_value": "true",
81                         "updated_at": "2024-01-15T09:30:00Z",
82                         "comparison_trait": {
83                           "created_at": "2024-01-15T09:30:00Z",
84                           "display_name": "Is Enterprise Customer",
85                           "entity_type": "company",
86                           "hierarchy": [
87                             "subscription",
88                             "customer"
89                           ],
90                           "id": "trait_001",
91                           "trait_type": "boolean",
92                           "updated_at": "2024-01-15T09:30:00Z"
93                         },
94                         "comparison_trait_id": "trait_001",
95                         "condition_group_id": "cond_group_001",
96                         "event_subtype": "usage",
97                         "flag_id": "flag_001",
98                         "metric_period": "monthly",
99                         "metric_period_month_reset": "first",
100                         "metric_value": 1,
101                         "trait": {
102                           "created_at": "2024-01-15T09:30:00Z",
103                           "display_name": "Is Enterprise Customer",
104                           "entity_type": "company",
105                           "hierarchy": [
106                             "subscription",
107                             "customer"
108                           ],
109                           "id": "trait_001",
110                           "trait_type": "boolean",
111                           "updated_at": "2024-01-15T09:30:00Z"
112                         },
113                         "trait_entity_type": "company",
114                         "trait_id": "trait_001"
115                       }
116                     ],
117                     "created_at": "2024-01-15T09:30:00Z",
118                     "environment_id": "env_1234567890abcdef",
119                     "id": "cond_group_001",
120                     "rule_id": "rule_001",
121                     "updated_at": "2024-01-15T09:30:00Z",
122                     "flag_id": "flag_001"
123                   }
124                 ],
125                 "conditions": [
126                   {
127                     "condition_type": "equals",
128                     "created_at": "2024-01-15T09:30:00Z",
129                     "environment_id": "env_1234567890abcdef",
130                     "id": "cond_002",
131                     "operator": "equals",
132                     "resource_ids": [
133                       "resource_001"
134                     ],
135                     "resources": [
136                       {
137                         "id": "resource_001",
138                         "name": "Enterprise Resource",
139                         "description": "Enterprise customer resource",
140                         "image_url": "https://example.com/images/resource_001.png"
141                       }
142                     ],
143                     "rule_id": "rule_001",
144                     "trait_value": "true",
145                     "updated_at": "2024-01-15T09:30:00Z",
146                     "comparison_trait": {
147                       "created_at": "2024-01-15T09:30:00Z",
148                       "display_name": "Is Enterprise Customer",
149                       "entity_type": "company",
150                       "hierarchy": [
151                         "subscription",
152                         "customer"
153                       ],
154                       "id": "trait_001",
155                       "trait_type": "boolean",
156                       "updated_at": "2024-01-15T09:30:00Z"
157                     },
158                     "comparison_trait_id": "trait_001",
159                     "condition_group_id": "cond_group_001",
160                     "event_subtype": "usage",
161                     "flag_id": "flag_001",
162                     "metric_period": "monthly",
163                     "metric_period_month_reset": "first",
164                     "metric_value": 1,
165                     "trait": {
166                       "created_at": "2024-01-15T09:30:00Z",
167                       "display_name": "Is Enterprise Customer",
168                       "entity_type": "company",
169                       "hierarchy": [
170                         "subscription",
171                         "customer"
172                       ],
173                       "id": "trait_001",
174                       "trait_type": "boolean",
175                       "updated_at": "2024-01-15T09:30:00Z"
176                     },
177                     "trait_entity_type": "company",
178                     "trait_id": "trait_001"
179                   }
180                 ],
181                 "created_at": "2024-01-15T09:30:00Z",
182                 "environment_id": "env_1234567890abcdef",
183                 "id": "rule_001",
184                 "name": "Enterprise Customer Rule",
185                 "priority": 1,
186                 "rule_type": "access_control",
187                 "updated_at": "2024-01-15T09:30:00Z",
188                 "value": true,
189                 "flag_id": "flag_001"
190               }
191             ],
192             "updated_at": "2024-01-15T09:30:00Z",
193             "feature": {
194               "created_at": "2024-01-15T09:30:00Z",
195               "description": "Flag controlling access to analytics.",
196               "feature_type": "boolean",
197               "icon": "blue",
198               "id": "flag_feature_001",
199               "name": "Advanced Analytics Flag",
200               "updated_at": "2024-01-15T09:30:00Z",
201               "event_subtype": "usage",
202               "lifecycle_phase": "ga",
203               "maintainer_id": "maintainer_001",
204               "plural_name": "Advanced Analytics Flags",
205               "singular_name": "Advanced Analytics Flag",
206               "trait_id": "trait_001"
207             },
208             "feature_id": "feature_001",
209             "last_checked_at": "2024-04-10T12:00:00Z",
210             "maintainer_id": "maintainer_001"
211           }
212         ],
213         "icon": "blue",
214         "id": "feature_001",
215         "name": "Advanced Analytics",
216         "plans": [
217           {
218             "id": "plan_001",
219             "name": "Premium Plan",
220             "description": "Premium Plan",
221             "image_url": "https://example.com/images/premium_plan.png"
222           }
223         ],
224         "updated_at": "2024-01-15T09:30:00Z",
225         "billing_linked_resource": {
226           "billing_provider": "orb",
227           "external_resource_id": "feature_ext_001",
228           "originator": "orb"
229         },
230         "event_subtype": "usage",
231         "event_summary": {
232           "company_count": 120,
233           "environment_id": "env_1234567890abcdef",
234           "event_count": 5000,
235           "event_subtype": "usage",
236           "user_count": 450,
237           "last_seen_at": "2024-04-10T12:00:00Z"
238         },
239         "lifecycle_phase": "ga",
240         "maintainer_id": "maintainer_001",
241         "plural_name": "Advanced Analytics Features",
242         "singular_name": "Advanced Analytics Feature",
243         "trait": {
244           "created_at": "2024-01-15T09:30:00Z",
245           "display_name": "Analytics Enabled",
246           "entity_type": "company",
247           "hierarchy": [
248             "subscription",
249             "feature"
250           ],
251           "id": "trait_001",
252           "trait_type": "boolean",
253           "updated_at": "2024-01-15T09:30:00Z"
254         },
255         "trait_id": "trait_001"
256       }
257     ],
258     "icon": "amber",
259     "id": "plan_001",
260     "is_free": false,
261     "is_trialable": true,
262     "name": "Premium Plan",
263     "plan_type": "plan",
264     "updated_at": "2024-01-15T09:30:00Z",
265     "versions": [
266       {
267         "created_at": "2024-01-15T09:30:00Z",
268         "description": "Initial release of the Premium Plan with all core features enabled.",
269         "environment_id": "env_1234567890abcdef",
270         "icon": "amber",
271         "id": "plan_version_001",
272         "name": "Premium Plan v1",
273         "plan_type": "plan",
274         "status": "published",
275         "updated_at": "2024-01-15T09:30:00Z",
276         "version": 1,
277         "original_plan_id": "plan_001"
278       }
279     ],
280     "is_default": false,
281     "active_version": {
282       "created_at": "2024-01-15T09:30:00Z",
283       "description": "Initial release of the Premium Plan with all core features enabled.",
284       "environment_id": "env_1234567890abcdef",
285       "icon": "amber",
286       "id": "plan_version_001",
287       "name": "Premium Plan v1",
288       "plan_type": "plan",
289       "status": "published",
290       "updated_at": "2024-01-15T09:30:00Z",
291       "version": 1,
292       "original_plan_id": "plan_001"
293     },
294     "billing_linked_resource": {
295       "billing_provider": "orb",
296       "external_resource_id": "ext_res_987654321",
297       "originator": "orb"
298     },
299     "billing_product": {
300       "account_id": "acct_123456789",
301       "created_at": "2024-01-15T09:30:00Z",
302       "environment_id": "env_1234567890abcdef",
303       "external_id": "prod_ext_001",
304       "is_active": true,
305       "name": "Premium Product",
306       "price": 29.99,
307       "prices": [
308         {
309           "currency": "USD",
310           "external_price_id": "price_ext_001",
311           "id": "price_001",
312           "interval": "month",
313           "price": 2999,
314           "provider_type": "orb",
315           "scheme": "per_unit",
316           "price_decimal": "29.99"
317         }
318       ],
319       "product_id": "prod_001",
320       "provider_type": "orb",
321       "quantity": 1,
322       "subscription_count": 150,
323       "updated_at": "2024-01-15T09:30:00Z",
324       "price_decimal": "29.99",
325       "currency": "USD"
326     },
327     "draft_version": {
328       "created_at": "2024-01-15T09:30:00Z",
329       "description": "Draft version with upcoming feature enhancements.",
330       "environment_id": "env_1234567890abcdef",
331       "icon": "amber",
332       "id": "plan_version_002",
333       "name": "Premium Plan v2 Draft",
334       "plan_type": "plan",
335       "status": "draft",
336       "updated_at": "2024-01-15T09:30:00Z",
337       "version": 2,
338       "original_plan_id": "plan_001"
339     },
340     "included_credit_grants": [
341       {
342         "auto_topup_enabled": true,
343         "created_at": "2024-01-15T09:30:00Z",
344         "credit_amount": 100,
345         "credit_id": "credit_001",
346         "id": "credit_grant_001",
347         "plan_id": "plan_001",
348         "updated_at": "2024-01-15T09:30:00Z",
349         "credit_name": "API Usage Credits",
350         "plan_name": "Premium Plan",
351         "auto_topup_amount": 100,
352         "auto_topup_amount_type": "credits",
353         "auto_topup_expiry_type": "duration",
354         "auto_topup_expiry_unit": "billing_periods",
355         "auto_topup_expiry_unit_count": 3,
356         "auto_topup_threshold_credits": 20,
357         "auto_topup_threshold_percent": 10,
358         "credit": {
359           "burn_strategy": "expiration_priority",
360           "cost_editable": true,
361           "created_at": "2024-01-15T09:30:00Z",
362           "currency_prices": [
363             {
364               "currency": "USD",
365               "price": {
366                 "currency": "USD",
367                 "external_price_id": "price_ext_004",
368                 "id": "price_004",
369                 "interval": "month",
370                 "price": 1000,
371                 "provider_type": "orb",
372                 "scheme": "per_unit",
373                 "price_decimal": "10.00"
374               }
375             }
376           ],
377           "default_expiry_unit": "billing_periods",
378           "default_rollover_policy": "rollover",
379           "description": "Monthly credit bundle for API usage.",
380           "id": "credit_001",
381           "name": "API Usage Credits",
382           "updated_at": "2024-01-15T09:30:00Z",
383           "default_expiry_unit_count": 6,
384           "icon": "blue",
385           "plural_name": "API Usage Credits",
386           "price": {
387             "currency": "USD",
388             "external_price_id": "price_ext_004",
389             "id": "price_004",
390             "interval": "month",
391             "price": 1000,
392             "provider_type": "orb",
393             "scheme": "per_unit",
394             "price_decimal": "10.00"
395           },
396           "product": {
397             "account_id": "acct_123456789",
398             "created_at": "2024-01-15T09:30:00Z",
399             "environment_id": "env_1234567890abcdef",
400             "external_id": "prod_ext_002",
401             "is_active": true,
402             "name": "API Credit Product",
403             "price": 10,
404             "product_id": "prod_002",
405             "provider_type": "orb",
406             "quantity": 1,
407             "updated_at": "2024-01-15T09:30:00Z",
408             "price_decimal": "10.00",
409             "currency": "USD"
410           },
411           "singular_name": "API Usage Credit"
412         },
413         "expiry_type": "duration",
414         "expiry_unit": "billing_periods",
415         "expiry_unit_count": 6,
416         "plan": {
417           "id": "plan_001",
418           "name": "Premium Plan",
419           "description": "Premium Plan",
420           "image_url": "https://example.com/images/premium_plan.png"
421         },
422         "plan_version_id": "plan_version_001",
423         "reset_cadence": "monthly",
424         "reset_start": "billing_period",
425         "reset_type": "plan_period",
426         "credit_plural_name": "API Usage Credits",
427         "credit_singular_name": "API Usage Credit"
428       }
429     ],
430     "monthly_price": {
431       "currency": "USD",
432       "external_price_id": "price_ext_001",
433       "id": "price_001",
434       "interval": "month",
435       "price": 2999,
436       "provider_type": "orb",
437       "scheme": "per_unit",
438       "price_decimal": "29.99"
439     },
440     "one_time_price": {
441       "currency": "USD",
442       "external_price_id": "price_ext_002",
443       "id": "price_002",
444       "interval": "one-time",
445       "price": 2999,
446       "provider_type": "orb",
447       "scheme": "per_unit",
448       "price_decimal": "29.99"
449     },
450     "trial_days": 14,
451     "yearly_price": {
452       "currency": "USD",
453       "external_price_id": "price_ext_003",
454       "id": "price_003",
455       "interval": "year",
456       "price": 29999,
457       "provider_type": "orb",
458       "scheme": "per_unit",
459       "price_decimal": "299.99"
460     },
461     "audience_type": "general"
462   },
463   "params": {}
464 }

Authentication

X-Schematic-Api-Keystring

API Key authentication via header

Request

This endpoint expects an object.

descriptionstringRequired0-1024 characters

namestringRequired1-256 characters

plan_typeenumRequired

Allowed values:

iconenum or nullOptional

Response

Created

dataobject

paramsobject

Input parameters

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error