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

Request

This endpoint expects an object.

descriptionstringRequired

namestringRequired

plan_typeenumRequired

Allowed values:

iconstringOptional

Response

Created

dataobject

paramsmap from strings to any

Input parameters

Create plan

Headers

Request

Response

Errors