Get plan

GET

https://api.schematichq.com/plans/:plan_id

GET

/plans/:plan_id

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.plans.getPlan("plan_id", {});
8 }
9 main();

1 {
2   "data": {
3     "charge_type": "recurring",
4     "company_count": 120,
5     "controlled_by": "stripe",
6     "created_at": "2023-12-01T09:00:00Z",
7     "description": "Standard subscription plan offering core features for small businesses.",
8     "features": [
9       {
10         "created_at": "2023-12-01T09:00:00Z",
11         "description": "Access to basic analytics dashboard",
12         "feature_type": "boolean",
13         "flags": [
14           {
15             "created_at": "2023-12-01T09:00:00Z",
16             "default_value": true,
17             "description": "Enable analytics dashboard feature",
18             "flag_type": "boolean",
19             "id": "flag_001",
20             "key": "enable_analytics_dashboard",
21             "name": "Enable Analytics Dashboard",
22             "rules": [],
23             "updated_at": "2024-04-10T10:00:00Z",
24             "feature": {
25               "created_at": "2023-12-01T09:00:00Z",
26               "description": "Analytics dashboard feature flag",
27               "feature_type": "boolean",
28               "icon": "analytics_icon.png",
29               "id": "feature_analytics_001",
30               "name": "Analytics Dashboard",
31               "updated_at": "2024-04-10T10:00:00Z",
32               "lifecycle_phase": "ga",
33               "maintainer_id": "user_001",
34               "plural_name": "Analytics Dashboards",
35               "singular_name": "Analytics Dashboard"
36             },
37             "feature_id": "feature_analytics_001",
38             "last_checked_at": "2024-04-10T10:00:00Z",
39             "maintainer_id": "user_001"
40           }
41         ],
42         "icon": "analytics_icon.png",
43         "id": "feature_analytics_001",
44         "name": "Analytics Dashboard",
45         "plans": [
46           {
47             "id": "plan_abc123",
48             "name": "Standard Plan",
49             "description": "Standard subscription plan",
50             "image_url": "standard_plan_image.png"
51           }
52         ],
53         "updated_at": "2024-04-10T10:00:00Z",
54         "lifecycle_phase": "ga",
55         "maintainer_id": "user_001",
56         "plural_name": "Analytics Dashboards",
57         "singular_name": "Analytics Dashboard"
58       }
59     ],
60     "icon": "standard_plan_icon.png",
61     "id": "plan_abc123",
62     "is_free": false,
63     "is_trialable": true,
64     "name": "Standard Plan",
65     "plan_type": "plan",
66     "updated_at": "2024-04-10T10:00:00Z",
67     "versions": [
68       {
69         "created_at": "2024-01-01T08:00:00Z",
70         "description": "Initial published version",
71         "environment_id": "env_12345",
72         "icon": "standard_plan_icon.png",
73         "id": "plan_version_001",
74         "name": "Standard Plan v1",
75         "plan_type": "plan",
76         "status": "published",
77         "updated_at": "2024-04-10T10:00:00Z",
78         "version": 1,
79         "original_plan_id": "plan_abc123"
80       },
81       {
82         "created_at": "2024-04-01T09:00:00Z",
83         "description": "Draft version with updated pricing",
84         "environment_id": "env_12345",
85         "icon": "standard_plan_icon_draft.png",
86         "id": "plan_version_002",
87         "name": "Standard Plan v2 Draft",
88         "plan_type": "plan",
89         "status": "draft",
90         "updated_at": "2024-04-01T09:00:00Z",
91         "version": 2,
92         "original_plan_id": "plan_abc123"
93       }
94     ],
95     "is_default": false,
96     "active_version": {
97       "created_at": "2024-04-10T10:00:00Z",
98       "description": "Current active version of the standard subscription plan",
99       "environment_id": "env_12345",
100       "icon": "standard_plan_icon.png",
101       "id": "plan_version_001",
102       "name": "Standard Plan v1",
103       "plan_type": "plan",
104       "status": "published",
105       "updated_at": "2024-04-10T10:00:00Z",
106       "version": 1,
107       "original_plan_id": "plan_abc123"
108     },
109     "billing_product": {
110       "account_id": "acct_78910",
111       "created_at": "2024-01-01T08:00:00Z",
112       "environment_id": "env_12345",
113       "external_id": "prod_ext_001",
114       "is_active": true,
115       "name": "Standard Subscription Product",
116       "price": 29.99,
117       "prices": [
118         {
119           "currency": "USD",
120           "external_price_id": "price_ext_001",
121           "id": "price_001",
122           "interval": "month",
123           "price": 2999,
124           "provider_type": "stripe",
125           "scheme": "per_unit",
126           "price_decimal": "29.99"
127         }
128       ],
129       "product_id": "prod_001",
130       "provider_type": "stripe",
131       "quantity": 1,
132       "subscription_count": 1500,
133       "updated_at": "2024-04-10T10:00:00Z",
134       "price_decimal": "29.99"
135     },
136     "draft_version": {
137       "created_at": "2024-04-01T09:00:00Z",
138       "description": "Draft version with updated pricing and features",
139       "environment_id": "env_12345",
140       "icon": "standard_plan_icon_draft.png",
141       "id": "plan_version_002",
142       "name": "Standard Plan v2 Draft",
143       "plan_type": "plan",
144       "status": "draft",
145       "updated_at": "2024-04-01T09:00:00Z",
146       "version": 2,
147       "original_plan_id": "plan_abc123"
148     },
149     "included_credit_grants": [
150       {
151         "auto_topup_enabled": true,
152         "created_at": "2023-12-01T09:00:00Z",
153         "credit_amount": 1000,
154         "credit_id": "credit_001",
155         "id": "credit_grant_001",
156         "plan_id": "plan_abc123",
157         "updated_at": "2024-04-10T10:00:00Z",
158         "credit_name": "API Call Credit",
159         "plan_name": "Standard Plan",
160         "auto_topup_amount": 100,
161         "auto_topup_amount_type": "credits",
162         "auto_topup_expiry_type": "duration",
163         "auto_topup_expiry_unit": "billing_periods",
164         "auto_topup_expiry_unit_count": 1,
165         "auto_topup_threshold_percent": 20,
166         "credit": {
167           "burn_strategy": "expiration_priority",
168           "cost_editable": true,
169           "created_at": "2023-12-01T09:00:00Z",
170           "default_expiry_unit": "billing_periods",
171           "default_rollover_policy": "rollover",
172           "description": "Monthly API call credits",
173           "id": "credit_001",
174           "name": "API Call Credit",
175           "updated_at": "2024-04-10T10:00:00Z",
176           "default_expiry_unit_count": 3,
177           "icon": "credit_icon.png",
178           "plural_name": "API Call Credits",
179           "price": {
180             "currency": "USD",
181             "external_price_id": "price_credit_001",
182             "id": "price_cred_001",
183             "interval": "month",
184             "price": 0,
185             "provider_type": "schematic",
186             "scheme": "per_unit",
187             "price_decimal": "0.00"
188           },
189           "product": {
190             "account_id": "acct_78910",
191             "created_at": "2023-12-01T09:00:00Z",
192             "environment_id": "env_12345",
193             "external_id": "prod_credit_001",
194             "is_active": true,
195             "name": "API Call Credit Product",
196             "price": 0,
197             "product_id": "prod_credit_001",
198             "provider_type": "schematic",
199             "quantity": 1,
200             "updated_at": "2024-04-10T10:00:00Z",
201             "price_decimal": "0.00"
202           },
203           "singular_name": "API Call Credit"
204         },
205         "expiry_type": "duration",
206         "expiry_unit": "billing_periods",
207         "expiry_unit_count": 3,
208         "plan": {
209           "id": "plan_abc123",
210           "name": "Standard Plan",
211           "description": "Standard subscription plan",
212           "image_url": "standard_plan_image.png"
213         },
214         "plan_version_id": "plan_version_001",
215         "reset_cadence": "monthly",
216         "reset_start": "billing_period",
217         "reset_type": "plan_period",
218         "credit_plural_name": "API Call Credits",
219         "credit_singular_name": "API Call Credit"
220       }
221     ],
222     "monthly_price": {
223       "currency": "USD",
224       "external_price_id": "price_monthly_001",
225       "id": "price_monthly_001",
226       "interval": "month",
227       "price": 2999,
228       "provider_type": "stripe",
229       "scheme": "per_unit",
230       "price_decimal": "29.99"
231     },
232     "one_time_price": {
233       "currency": "USD",
234       "external_price_id": "price_onetime_001",
235       "id": "price_onetime_001",
236       "interval": "one-time",
237       "price": 9999,
238       "provider_type": "stripe",
239       "scheme": "per_unit",
240       "price_decimal": "99.99"
241     },
242     "trial_days": 14,
243     "yearly_price": {
244       "currency": "USD",
245       "external_price_id": "price_yearly_001",
246       "id": "price_yearly_001",
247       "interval": "year",
248       "price": 29999,
249       "provider_type": "stripe",
250       "scheme": "per_unit",
251       "price_decimal": "299.99"
252     }
253   },
254   "params": {
255     "plan_version_id": "plan_version_001"
256   }
257 }

Authentication

X-Schematic-Api-Keystring

API Key authentication via header

Path parameters

plan_idstringRequired

plan_id

Query parameters

plan_version_idstringOptional

Fetch billing settings for a specific plan version

Response

dataobject

paramsobject

Input parameters

Errors

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error