List plans

GET

https://api.schematichq.com/plans

GET

/plans

1 import { SchematicClient } from "@schematichq/schematic-typescript-node";
2 
3 const client = new SchematicClient({ apiKey: "YOUR_API_KEY" });
4 await client.plans.listPlans();

Try it

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

Query parameters

company_idstringOptional

has_product_idbooleanOptional

Filter out plans that do not have a billing product ID

idslist of stringsOptional

plan_typeenumOptional

Filter by plan type

Allowed values:

qstringOptional

without_entitlement_forstringOptional

Filter out plans that already have a plan entitlement for the specified feature ID

without_product_idbooleanOptional

Filter out plans that have a billing product ID

without_paid_product_idbooleanOptional

Filter out plans that have a paid billing product ID

limitintegerOptional

Page limit (default 100)

offsetintegerOptional

Page offset (default 0)

Response

datalist of objects

The returned resources

paramsobject

Input parameters

List plans

Headers

Query parameters

Response

Errors