Create plan

POST

Request

This endpoint expects an object.

descriptionstringRequired

namestringRequired

plan_type"plan" or "add_on"Required

Allowed values: planadd_on

iconstringOptional

Response

This endpoint returns an object

dataobject

paramsmap from strings to any

Input parameters

POST

1 curl -X POST https://api.schematichq.com/plans \
2      -H "X-Schematic-Api-Key: <apiKey>" \
3      -H "Content-Type: application/json" \
4      -d '{
5   "description": "description",
6   "name": "name",
7   "plan_type": "plan"
8 }'

200Successful

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

Built with

1	curl -X POST https://api.schematichq.com/plans \
2	-H "X-Schematic-Api-Key: <apiKey>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"description": "description",
6	"name": "name",
7	"plan_type": "plan"
8	}'

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