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

Path parameters

plan_idstringRequired

plan_id

Response

dataobject

paramsmap from strings to any

Input parameters

Get plan

Path parameters

Headers

Response

Errors