List plans

GET

Query parameters

company_idstringOptional

has_product_idbooleanOptional

Filter out plans that do not have a billing product ID

idsstringOptional

plan_type"plan" or "add_on"Optional

Filter by plan type

Allowed values: planadd_on

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

limitintegerOptional

Page limit (default 100)

offsetintegerOptional

Page offset (default 0)

Response

datalist of objects

The returned resources

paramsobject

Input parameters

GET

1 curl https://api.schematichq.com/plans \
2      -H "X-Schematic-Api-Key: <apiKey>"

200Retrieved

1 {
2   "data": [
3     {
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       "name": "name",
103       "plan_type": "plan_type",
104       "updated_at": "2024-01-15T09:30:00Z",
105       "audience_type": "audience_type",
106       "billing_product": {
107         "Prices": [
108           {
109             "currency": "currency",
110             "external_price_id": "external_price_id",
111             "id": "id",
112             "interval": "interval",
113             "price": 1
114           }
115         ],
116         "account_id": "account_id",
117         "created_at": "2024-01-15T09:30:00Z",
118         "currency": "currency",
119         "environment_id": "environment_id",
120         "external_id": "external_id",
121         "name": "name",
122         "price": 1.1,
123         "product_id": "product_id",
124         "quantity": 1.1,
125         "updated_at": "2024-01-15T09:30:00Z"
126       },
127       "monthly_price": {
128         "currency": "currency",
129         "external_price_id": "external_price_id",
130         "id": "id",
131         "interval": "interval",
132         "price": 1
133       },
134       "yearly_price": {
135         "currency": "currency",
136         "external_price_id": "external_price_id",
137         "id": "id",
138         "interval": "interval",
139         "price": 1
140       }
141     }
142   ],
143   "params": {
144     "company_id": "company_id",
145     "has_product_id": true,
146     "ids": [
147       "ids"
148     ],
149     "limit": 1,
150     "offset": 1,
151     "plan_type": "plan",
152     "q": "q",
153     "without_entitlement_for": "without_entitlement_for",
154     "without_product_id": true
155   }
156 }

Built with

1	curl https://api.schematichq.com/plans \
2	-H "X-Schematic-Api-Key: <apiKey>"

1	{
2	"data": [
3	{
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	"name": "name",
103	"plan_type": "plan_type",
104	"updated_at": "2024-01-15T09:30:00Z",
105	"audience_type": "audience_type",
106	"billing_product": {
107	"Prices": [
108	{
109	"currency": "currency",
110	"external_price_id": "external_price_id",
111	"id": "id",
112	"interval": "interval",
113	"price": 1
114	}
115	],
116	"account_id": "account_id",
117	"created_at": "2024-01-15T09:30:00Z",
118	"currency": "currency",
119	"environment_id": "environment_id",
120	"external_id": "external_id",
121	"name": "name",
122	"price": 1.1,
123	"product_id": "product_id",
124	"quantity": 1.1,
125	"updated_at": "2024-01-15T09:30:00Z"
126	},
127	"monthly_price": {
128	"currency": "currency",
129	"external_price_id": "external_price_id",
130	"id": "id",
131	"interval": "interval",
132	"price": 1
133	},
134	"yearly_price": {
135	"currency": "currency",
136	"external_price_id": "external_price_id",
137	"id": "id",
138	"interval": "interval",
139	"price": 1
140	}
141	}
142	],
143	"params": {
144	"company_id": "company_id",
145	"has_product_id": true,
146	"ids": [
147	"ids"
148	],
149	"limit": 1,
150	"offset": 1,
151	"plan_type": "plan",
152	"q": "q",
153	"without_entitlement_for": "without_entitlement_for",
154	"without_product_id": true
155	}
156	}