List plan entitlements

GET

https://api.schematichq.com/plan-entitlements

GET

/plan-entitlements

1 import { SchematicClient } from "@schematichq/schematic-typescript-node";
2 
3 async function main() {
4     const client = new SchematicClient({
5         apiKey: "YOUR_API_KEY_HERE",
6     });
7     await client.entitlements.listPlanEntitlements({});
8 }
9 main();

1 {
2   "data": [
3     {
4       "created_at": "2024-01-15T09:30:00Z",
5       "environment_id": "env_9f8a7b6c5d4e3f2a1b0c",
6       "feature_id": "feat_123abc456def",
7       "id": "pltl_987zyx654wvu",
8       "plan_id": "plan_pro_001",
9       "rule_id": "rule_456def789abc",
10       "updated_at": "2024-01-15T09:30:00Z",
11       "value_type": "boolean",
12       "billing_threshold": 100,
13       "consumption_rate": 0.05,
14       "feature": {
15         "created_at": "2023-11-20T12:00:00Z",
16         "description": "Access to advanced analytics dashboard",
17         "feature_type": "boolean",
18         "icon": "analytics-chart",
19         "id": "feat_123abc456def",
20         "name": "Advanced Analytics",
21         "updated_at": "2024-01-10T15:45:00Z",
22         "lifecycle_phase": "add_on",
23         "maintainer_id": "mnt_789xyz123abc",
24         "plural_name": "Advanced Analytics Features",
25         "singular_name": "Advanced Analytics Feature"
26       },
27       "metered_monthly_price": {
28         "billing_scheme": "per_unit",
29         "created_at": "2023-12-01T08:00:00Z",
30         "currency": "USD",
31         "id": "price_001monthly",
32         "interval": "month",
33         "is_active": true,
34         "package_size": 1,
35         "price": 1500,
36         "price_external_id": "ext_price_monthly_001",
37         "price_id": "price_001monthly",
38         "price_tier": [
39           {
40             "flat_amount": 0,
41             "per_unit_price": 1500,
42             "per_unit_price_decimal": "15.00",
43             "up_to": 1000
44           }
45         ],
46         "product_external_id": "prod_ext_analytics_monthly",
47         "product_id": "prod_analytics_monthly",
48         "product_name": "Advanced Analytics Monthly",
49         "provider_type": "schematic",
50         "updated_at": "2024-01-10T08:00:00Z",
51         "usage_type": "metered",
52         "meter_event_name": "analytics_usage",
53         "meter_event_payload_key": "events_count",
54         "meter_id": "meter_analytics_01",
55         "price_decimal": "15.00",
56         "tiers_mode": "graduated"
57       },
58       "metered_yearly_price": {
59         "billing_scheme": "per_unit",
60         "created_at": "2023-12-01T08:00:00Z",
61         "currency": "USD",
62         "id": "price_001yearly",
63         "interval": "year",
64         "is_active": true,
65         "package_size": 1,
66         "price": 15000,
67         "price_external_id": "ext_price_yearly_001",
68         "price_id": "price_001yearly",
69         "price_tier": [
70           {
71             "flat_amount": 0,
72             "per_unit_price": 15000,
73             "per_unit_price_decimal": "150.00",
74             "up_to": 12000
75           }
76         ],
77         "product_external_id": "prod_ext_analytics_yearly",
78         "product_id": "prod_analytics_yearly",
79         "product_name": "Advanced Analytics Yearly",
80         "provider_type": "schematic",
81         "updated_at": "2024-01-10T08:00:00Z",
82         "usage_type": "metered",
83         "meter_event_name": "analytics_usage",
84         "meter_event_payload_key": "events_count",
85         "meter_id": "meter_analytics_01",
86         "price_decimal": "150.00",
87         "tiers_mode": "graduated"
88       },
89       "metric_period": "monthly",
90       "metric_period_month_reset": "1",
91       "plan": {
92         "created_at": "2023-10-01T10:00:00Z",
93         "description": "Pro Plan with advanced features and priority support",
94         "icon": "pro-plan-icon",
95         "id": "plan_pro_001",
96         "name": "Pro Plan",
97         "plan_type": "plan",
98         "updated_at": "2024-01-05T11:00:00Z"
99       },
100       "price_behavior": "pay_as_you_go",
101       "rule_id_usage_exceeded": "rule_456def789abc_exceeded",
102       "soft_limit": 5000,
103       "usage_based_product": {
104         "account_id": "acc_1234567890",
105         "created_at": "2023-11-15T09:00:00Z",
106         "environment_id": "env_9f8a7b6c5d4e3f2a1b0c",
107         "external_id": "ext_prod_analytics_usage",
108         "is_active": true,
109         "name": "Analytics Usage Product",
110         "price": 0.05,
111         "product_id": "prod_analytics_usage_001",
112         "provider_type": "schematic",
113         "quantity": 1,
114         "updated_at": "2024-01-10T09:00:00Z",
115         "price_decimal": "0.05"
116       },
117       "value_bool": true,
118       "value_credit": {
119         "burn_strategy": "expiration_priority",
120         "cost_editable": false,
121         "created_at": "2023-11-20T10:00:00Z",
122         "default_expiry_unit": "billing_periods",
123         "default_rollover_policy": "rollover",
124         "description": "Credit for additional analytics events",
125         "id": "credit_analytics_001",
126         "name": "Analytics Event Credit",
127         "updated_at": "2024-01-10T10:00:00Z",
128         "default_expiry_unit_count": 3,
129         "plural_name": "Analytics Event Credits",
130         "price": {
131           "currency": "USD",
132           "external_price_id": "ext_price_credit_001",
133           "id": "price_credit_001",
134           "interval": "month",
135           "price": 1000,
136           "provider_type": "schematic",
137           "scheme": "per_unit",
138           "price_decimal": "10.00"
139         },
140         "product": {
141           "account_id": "acc_1234567890",
142           "created_at": "2023-11-15T09:00:00Z",
143           "environment_id": "env_9f8a7b6c5d4e3f2a1b0c",
144           "external_id": "ext_prod_analytics_credit",
145           "is_active": true,
146           "name": "Analytics Credit Product",
147           "price": 0.1,
148           "product_id": "prod_analytics_credit_001",
149           "provider_type": "schematic",
150           "quantity": 1,
151           "updated_at": "2024-01-10T09:00:00Z",
152           "price_decimal": "0.10"
153         },
154         "singular_name": "Analytics Event Credit"
155       },
156       "value_numeric": 1000,
157       "value_trait": {
158         "created_at": "2023-12-01T08:00:00Z",
159         "display_name": "Company Tier",
160         "entity_type": "company",
161         "hierarchy": [
162           "basic",
163           "pro",
164           "enterprise"
165         ],
166         "id": "trait_company_tier",
167         "trait_type": "string",
168         "updated_at": "2024-01-10T08:00:00Z"
169       },
170       "value_trait_id": "trait_company_tier"
171     }
172   ],
173   "params": {
174     "feature_id": "feat_123abc456def",
175     "feature_ids": [
176       "feat_123abc456def",
177       "feat_789xyz654wvu"
178     ],
179     "ids": [
180       "pltl_987zyx654wvu",
181       "pltl_654wvu321zyx"
182     ],
183     "limit": 100,
184     "offset": 0,
185     "plan_id": "plan_pro_001",
186     "plan_ids": [
187       "plan_pro_001",
188       "plan_basic_002"
189     ],
190     "plan_version_id": "plvr_20240101",
191     "plan_version_ids": [
192       "plvr_20240101",
193       "plvr_20231201"
194     ],
195     "q": "analytics",
196     "with_metered_products": true
197   }
198 }

Authentication

X-Schematic-Api-Keystring

API Key authentication via header

Query parameters

feature_idstringOptional

Filter plan entitlements by a single feature ID (starting with feat_)

feature_idslist of stringsOptional

Filter plan entitlements by multiple feature IDs (starting with feat_)

idslist of stringsOptional

Filter plan entitlements by multiple plan entitlement IDs (starting with pltl_)

plan_idstringOptional

Filter plan entitlements by a single plan ID (starting with plan_)

plan_idslist of stringsOptional

Filter plan entitlements by multiple plan IDs (starting with plan_)

plan_version_idstringOptional

Filter plan entitlements by a single plan version ID (starting with plvr_)

plan_version_idslist of stringsOptional

Filter plan entitlements by multiple plan version IDs (starting with plvr_)

qstringOptional

Search for plan entitlements by feature or company name

with_metered_productsbooleanOptional

Filter plan entitlements only with metered products

limitintegerOptional

Page limit (default 100)

offsetintegerOptional

Page offset (default 0)

Response

datalist of objects

paramsobject

Input parameters

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error