List plans

GET

https://api.schematichq.com/plans

GET

/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.listPlans({});
8 }
9 main();

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

Authentication

X-Schematic-Api-Keystring

API Key authentication via header

Query parameters

company_idstringOptional

for_fallback_planbooleanOptional

Filter for plans valid as fallback plans (not linked to billing)

for_initial_planbooleanOptional

Filter for plans valid as initial plans (not linked to billing, free, or auto-cancelling trial)

for_trial_expiry_planbooleanOptional

Filter for plans valid as trial expiry plans (not linked to billing or free)

has_product_idbooleanOptional

Filter out plans that do not have a billing product ID

idslist of stringsOptional

include_draft_versionsbooleanOptional

Include billing settings from draft versions for plans which have draft version

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_paid_product_idbooleanOptional

Filter out plans that have a paid billing product ID

limitlongOptional

Page limit (default 100)

offsetlongOptional

Page offset (default 0)

Response

datalist of objects

paramsobject

Input parameters

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error