Create plan

POST

Request

This endpoint expects an object.

descriptionstringRequired

namestringRequired

plan_typeenumRequired

Allowed values: planadd_on

iconstringOptional

Response

Created

dataobject

paramsmap from strings to any

Input parameters

POST

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

201Created

1 {
2   "data": {
3     "company_count": 1,
4     "created_at": "2024-01-15T09:30:00Z",
5     "description": "description",
6     "features": [
7       {
8         "created_at": "2024-01-15T09:30:00Z",
9         "description": "description",
10         "feature_type": "feature_type",
11         "flags": [
12           {
13             "created_at": "2024-01-15T09:30:00Z",
14             "default_value": true,
15             "description": "description",
16             "flag_type": "flag_type",
17             "id": "id",
18             "key": "key",
19             "name": "name",
20             "rules": [
21               {
22                 "condition_groups": [
23                   {
24                     "conditions": [
25                       {
26                         "condition_type": "condition_type",
27                         "created_at": "2024-01-15T09:30:00Z",
28                         "environment_id": "environment_id",
29                         "id": "id",
30                         "operator": "operator",
31                         "resource_ids": [
32                           "resource_ids"
33                         ],
34                         "resources": [
35                           {
36                             "id": "id",
37                             "name": "name"
38                           }
39                         ],
40                         "rule_id": "rule_id",
41                         "trait_value": "trait_value",
42                         "updated_at": "2024-01-15T09:30:00Z"
43                       }
44                     ],
45                     "created_at": "2024-01-15T09:30:00Z",
46                     "environment_id": "environment_id",
47                     "id": "id",
48                     "rule_id": "rule_id",
49                     "updated_at": "2024-01-15T09:30:00Z"
50                   }
51                 ],
52                 "conditions": [
53                   {
54                     "condition_type": "condition_type",
55                     "created_at": "2024-01-15T09:30:00Z",
56                     "environment_id": "environment_id",
57                     "id": "id",
58                     "operator": "operator",
59                     "resource_ids": [
60                       "resource_ids"
61                     ],
62                     "resources": [
63                       {
64                         "id": "id",
65                         "name": "name"
66                       }
67                     ],
68                     "rule_id": "rule_id",
69                     "trait_value": "trait_value",
70                     "updated_at": "2024-01-15T09:30:00Z"
71                   }
72                 ],
73                 "created_at": "2024-01-15T09:30:00Z",
74                 "environment_id": "environment_id",
75                 "id": "id",
76                 "name": "name",
77                 "priority": 1,
78                 "rule_type": "rule_type",
79                 "updated_at": "2024-01-15T09:30:00Z",
80                 "value": true
81               }
82             ],
83             "updated_at": "2024-01-15T09:30:00Z"
84           }
85         ],
86         "icon": "icon",
87         "id": "id",
88         "name": "name",
89         "plans": [
90           {
91             "id": "id",
92             "name": "name"
93           }
94         ],
95         "updated_at": "2024-01-15T09:30:00Z"
96       }
97     ],
98     "icon": "icon",
99     "id": "id",
100     "is_default": true,
101     "is_free": true,
102     "is_trialable": true,
103     "name": "name",
104     "plan_type": "plan_type",
105     "updated_at": "2024-01-15T09:30:00Z",
106     "audience_type": "audience_type",
107     "billing_product": {
108       "account_id": "account_id",
109       "created_at": "2024-01-15T09:30:00Z",
110       "currency": "currency",
111       "environment_id": "environment_id",
112       "external_id": "external_id",
113       "name": "name",
114       "price": 1.1,
115       "prices": [
116         {
117           "currency": "currency",
118           "external_price_id": "external_price_id",
119           "id": "id",
120           "interval": "interval",
121           "price": 1
122         }
123       ],
124       "product_id": "product_id",
125       "quantity": 1.1,
126       "updated_at": "2024-01-15T09:30:00Z"
127     },
128     "monthly_price": {
129       "currency": "currency",
130       "external_price_id": "external_price_id",
131       "id": "id",
132       "interval": "interval",
133       "price": 1
134     },
135     "trial_days": 1,
136     "yearly_price": {
137       "currency": "currency",
138       "external_price_id": "external_price_id",
139       "id": "id",
140       "interval": "interval",
141       "price": 1
142     }
143   },
144   "params": {
145     "key": "value"
146   }
147 }

Built with

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

1	{
2	"data": {
3	"company_count": 1,
4	"created_at": "2024-01-15T09:30:00Z",
5	"description": "description",
6	"features": [
7	{
8	"created_at": "2024-01-15T09:30:00Z",
9	"description": "description",
10	"feature_type": "feature_type",
11	"flags": [
12	{
13	"created_at": "2024-01-15T09:30:00Z",
14	"default_value": true,
15	"description": "description",
16	"flag_type": "flag_type",
17	"id": "id",
18	"key": "key",
19	"name": "name",
20	"rules": [
21	{
22	"condition_groups": [
23	{
24	"conditions": [
25	{
26	"condition_type": "condition_type",
27	"created_at": "2024-01-15T09:30:00Z",
28	"environment_id": "environment_id",
29	"id": "id",
30	"operator": "operator",
31	"resource_ids": [
32	"resource_ids"
33	],
34	"resources": [
35	{
36	"id": "id",
37	"name": "name"
38	}
39	],
40	"rule_id": "rule_id",
41	"trait_value": "trait_value",
42	"updated_at": "2024-01-15T09:30:00Z"
43	}
44	],
45	"created_at": "2024-01-15T09:30:00Z",
46	"environment_id": "environment_id",
47	"id": "id",
48	"rule_id": "rule_id",
49	"updated_at": "2024-01-15T09:30:00Z"
50	}
51	],
52	"conditions": [
53	{
54	"condition_type": "condition_type",
55	"created_at": "2024-01-15T09:30:00Z",
56	"environment_id": "environment_id",
57	"id": "id",
58	"operator": "operator",
59	"resource_ids": [
60	"resource_ids"
61	],
62	"resources": [
63	{
64	"id": "id",
65	"name": "name"
66	}
67	],
68	"rule_id": "rule_id",
69	"trait_value": "trait_value",
70	"updated_at": "2024-01-15T09:30:00Z"
71	}
72	],
73	"created_at": "2024-01-15T09:30:00Z",
74	"environment_id": "environment_id",
75	"id": "id",
76	"name": "name",
77	"priority": 1,
78	"rule_type": "rule_type",
79	"updated_at": "2024-01-15T09:30:00Z",
80	"value": true
81	}
82	],
83	"updated_at": "2024-01-15T09:30:00Z"
84	}
85	],
86	"icon": "icon",
87	"id": "id",
88	"name": "name",
89	"plans": [
90	{
91	"id": "id",
92	"name": "name"
93	}
94	],
95	"updated_at": "2024-01-15T09:30:00Z"
96	}
97	],
98	"icon": "icon",
99	"id": "id",
100	"is_default": true,
101	"is_free": true,
102	"is_trialable": true,
103	"name": "name",
104	"plan_type": "plan_type",
105	"updated_at": "2024-01-15T09:30:00Z",
106	"audience_type": "audience_type",
107	"billing_product": {
108	"account_id": "account_id",
109	"created_at": "2024-01-15T09:30:00Z",
110	"currency": "currency",
111	"environment_id": "environment_id",
112	"external_id": "external_id",
113	"name": "name",
114	"price": 1.1,
115	"prices": [
116	{
117	"currency": "currency",
118	"external_price_id": "external_price_id",
119	"id": "id",
120	"interval": "interval",
121	"price": 1
122	}
123	],
124	"product_id": "product_id",
125	"quantity": 1.1,
126	"updated_at": "2024-01-15T09:30:00Z"
127	},
128	"monthly_price": {
129	"currency": "currency",
130	"external_price_id": "external_price_id",
131	"id": "id",
132	"interval": "interval",
133	"price": 1
134	},
135	"trial_days": 1,
136	"yearly_price": {
137	"currency": "currency",
138	"external_price_id": "external_price_id",
139	"id": "id",
140	"interval": "interval",
141	"price": 1
142	}
143	},
144	"params": {
145	"key": "value"
146	}
147	}