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");

Try it

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

Path parameters

plan_idstringRequired

plan_id

Response

dataobject

paramsmap from strings to any

Input parameters

Get plan

Path parameters

Headers

Response

Errors