Get plan

GET

https://api.schematichq.com/plans/:plan_id

GET

/plans/:plan_id

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

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

Authentication

X-Schematic-Api-Keystring

API Key authentication via header

Path parameters

plan_idstringRequired

plan_id

Query parameters

plan_version_idstringOptional

Fetch billing settings for a specific plan version

Response

dataobject

paramsobject

Input parameters

Authentication

Path parameters

Query parameters

Response

Errors