Get plan entitlement

GET

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

GET

/plan-entitlements/:plan_entitlement_id

1 import { SchematicClient } from "@schematichq/schematic-typescript-node";
2 
3 const client = new SchematicClient({ apiKey: "YOUR_API_KEY" });
4 await client.entitlements.getPlanEntitlement("plan_entitlement_id");

Try it

1 {
2   "data": {
3     "created_at": "2024-01-15T09:30:00Z",
4     "environment_id": "string",
5     "feature_id": "string",
6     "id": "string",
7     "plan_id": "string",
8     "rule_id": "string",
9     "updated_at": "2024-01-15T09:30:00Z",
10     "value_type": "string",
11     "billing_threshold": 1,
12     "consumption_rate": 1.1,
13     "feature": {
14       "created_at": "2024-01-15T09:30:00Z",
15       "description": "string",
16       "feature_type": "string",
17       "icon": "string",
18       "id": "string",
19       "name": "string",
20       "updated_at": "2024-01-15T09:30:00Z",
21       "event_subtype": "string",
22       "lifecycle_phase": "string",
23       "maintainer_id": "string",
24       "plural_name": "string",
25       "singular_name": "string",
26       "trait_id": "string"
27     },
28     "metered_monthly_price": {
29       "billing_scheme": "string",
30       "created_at": "2024-01-15T09:30:00Z",
31       "currency": "string",
32       "id": "string",
33       "interval": "string",
34       "is_active": true,
35       "package_size": 1,
36       "price": 1,
37       "price_external_id": "string",
38       "price_id": "string",
39       "price_tier": [
40         {
41           "flat_amount": 1,
42           "per_unit_price": 1,
43           "per_unit_price_decimal": "string",
44           "up_to": 1
45         }
46       ],
47       "product_external_id": "string",
48       "product_id": "string",
49       "product_name": "string",
50       "updated_at": "2024-01-15T09:30:00Z",
51       "usage_type": "string",
52       "meter_event_name": "string",
53       "meter_event_payload_key": "string",
54       "meter_id": "string",
55       "price_decimal": "string",
56       "tiers_mode": "string"
57     },
58     "metered_yearly_price": {
59       "billing_scheme": "string",
60       "created_at": "2024-01-15T09:30:00Z",
61       "currency": "string",
62       "id": "string",
63       "interval": "string",
64       "is_active": true,
65       "package_size": 1,
66       "price": 1,
67       "price_external_id": "string",
68       "price_id": "string",
69       "price_tier": [
70         {
71           "flat_amount": 1,
72           "per_unit_price": 1,
73           "per_unit_price_decimal": "string",
74           "up_to": 1
75         }
76       ],
77       "product_external_id": "string",
78       "product_id": "string",
79       "product_name": "string",
80       "updated_at": "2024-01-15T09:30:00Z",
81       "usage_type": "string",
82       "meter_event_name": "string",
83       "meter_event_payload_key": "string",
84       "meter_id": "string",
85       "price_decimal": "string",
86       "tiers_mode": "string"
87     },
88     "metric_period": "string",
89     "metric_period_month_reset": "string",
90     "plan": {
91       "created_at": "2024-01-15T09:30:00Z",
92       "description": "string",
93       "icon": "string",
94       "id": "string",
95       "name": "string",
96       "plan_type": "string",
97       "updated_at": "2024-01-15T09:30:00Z",
98       "audience_type": "string"
99     },
100     "price_behavior": "string",
101     "rule_id_usage_exceeded": "string",
102     "soft_limit": 1,
103     "usage_based_product": {
104       "account_id": "string",
105       "created_at": "2024-01-15T09:30:00Z",
106       "environment_id": "string",
107       "external_id": "string",
108       "is_active": true,
109       "name": "string",
110       "price": 1.1,
111       "product_id": "string",
112       "quantity": 1.1,
113       "updated_at": "2024-01-15T09:30:00Z",
114       "price_decimal": "string",
115       "currency": "string"
116     },
117     "value_bool": true,
118     "value_credit": {
119       "burn_strategy": "string",
120       "created_at": "2024-01-15T09:30:00Z",
121       "default_expiry_unit": "string",
122       "default_rollover_policy": "string",
123       "description": "string",
124       "id": "string",
125       "name": "string",
126       "updated_at": "2024-01-15T09:30:00Z",
127       "default_expiry_unit_count": 1,
128       "icon": "string",
129       "plural_name": "string",
130       "price": {
131         "currency": "string",
132         "external_price_id": "string",
133         "id": "string",
134         "interval": "string",
135         "price": 1,
136         "scheme": "string",
137         "price_decimal": "string"
138       },
139       "product": {
140         "account_id": "string",
141         "created_at": "2024-01-15T09:30:00Z",
142         "environment_id": "string",
143         "external_id": "string",
144         "is_active": true,
145         "name": "string",
146         "price": 1.1,
147         "product_id": "string",
148         "quantity": 1.1,
149         "updated_at": "2024-01-15T09:30:00Z",
150         "price_decimal": "string",
151         "currency": "string"
152       },
153       "singular_name": "string"
154     },
155     "value_numeric": 1,
156     "value_trait": {
157       "created_at": "2024-01-15T09:30:00Z",
158       "display_name": "string",
159       "entity_type": "string",
160       "hierarchy": [
161         "string"
162       ],
163       "id": "string",
164       "trait_type": "string",
165       "updated_at": "2024-01-15T09:30:00Z"
166     },
167     "value_trait_id": "string"
168   },
169   "params": {}
170 }

Authentication

X-Schematic-Api-Keystring

API Key authentication via header

Path parameters

plan_entitlement_idstringRequired

plan_entitlement_id

Response

dataobject

paramsobject

Input parameters

Authentication

Path parameters

Response

Errors