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

Try it

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

Query parameters

company_idstringOptional

has_product_idbooleanOptional

Filter out plans that do not have a billing product ID

idsstringOptional

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_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

The returned resources

paramsobject

Input parameters

List plans

Headers

Query parameters

Response

Errors