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({
5     companyId: "company_id",
6     forFallbackPlan: true,
7     forInitialPlan: true,
8     forTrialExpiryPlan: true,
9     hasProductId: true,
10     planType: "plan",
11     q: "q",
12     requiresPaymentMethod: true,
13     withoutEntitlementFor: "without_entitlement_for",
14     withoutProductId: true,
15     withoutPaidProductId: true,
16     limit: 1,
17     offset: 1
18 });

Try it

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

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

plan_typeenumOptional

Filter by plan type

Allowed values:

qstringOptional

requires_payment_methodbooleanOptional

Filter for plans that require a payment method (inverse of ForInitialPlan)

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

paramsobject

Input parameters

Authentication

Query parameters

Response

Errors