List plan credit grants

GET

https://api.schematichq.com/billing/credits/plan-grants

GET

/billing/credits/plan-grants

1 import { SchematicClient } from "@schematichq/schematic-typescript-node";
2 
3 const client = new SchematicClient({ apiKey: "YOUR_API_KEY" });
4 await client.credits.listBillingPlanCreditGrants({
5     creditId: "credit_id",
6     planId: "plan_id",
7     limit: 1,
8     offset: 1
9 });

1 {
2   "data": [
3     {
4       "auto_topup_enabled": true,
5       "created_at": "2024-01-15T09:30:00Z",
6       "credit_amount": 200,
7       "credit_id": "crd_9f8b7a6c5d4e3f2a1b0c",
8       "credit_name": "API Request Credit",
9       "id": "grant_1234567890abcdef",
10       "plan_id": "plan_pro_2024",
11       "reset_cadence": "monthly",
12       "reset_start": "billing_period",
13       "updated_at": "2024-01-15T09:30:00Z",
14       "plan_name": "Pro Plan",
15       "auto_topup_amount": 50,
16       "auto_topup_amount_type": "credits",
17       "auto_topup_expiry_type": "duration",
18       "auto_topup_expiry_unit": "billing_periods",
19       "auto_topup_expiry_unit_count": 3,
20       "auto_topup_threshold_percent": 20,
21       "credit_plural_name": "API Request Credits",
22       "credit_singular_name": "API Request Credit",
23       "expiry_type": "duration",
24       "expiry_unit": "billing_periods",
25       "expiry_unit_count": 6,
26       "plan": {
27         "id": "plan_pro_2024",
28         "name": "Pro Plan",
29         "description": "Pro Plan with extended API access and priority support",
30         "image_url": "https://cdn.schematichq.com/images/plans/pro_plan.png"
31       },
32       "plan_version_id": "v2.1.0",
33       "reset_type": "no_reset"
34     }
35   ],
36   "params": {
37     "credit_id": "crd_9f8b7a6c5d4e3f2a1b0c",
38     "ids": [
39       "grant_1234567890abcdef"
40     ],
41     "limit": 100,
42     "offset": 0,
43     "plan_id": "plan_pro_2024",
44     "plan_ids": [
45       "plan_pro_2024",
46       "plan_basic_2024"
47     ],
48     "plan_version_id": "v2.1.0"
49   }
50 }

Authentication

X-Schematic-Api-Keystring

API Key authentication via header

Query parameters

credit_idstringOptional

idslist of stringsOptional

plan_idstringOptional

plan_idslist of stringsOptional

plan_version_idstringOptional

limitintegerOptional

Page limit (default 100)

offsetintegerOptional

Page offset (default 0)

Response

datalist of objects

paramsobject

Input parameters

Authentication

Query parameters

Response

Errors