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 });

Try it

1 {
2   "data": [
3     {
4       "created_at": "2024-01-15T09:30:00Z",
5       "credit_amount": 1,
6       "credit_id": "string",
7       "credit_name": "string",
8       "id": "string",
9       "plan_id": "string",
10       "plan_name": "string",
11       "reset_cadence": "string",
12       "reset_start": "string",
13       "updated_at": "2024-01-15T09:30:00Z",
14       "credit_plural_name": "string",
15       "credit_singular_name": "string",
16       "expiry_type": "string",
17       "expiry_unit": "string",
18       "expiry_unit_count": 1,
19       "reset_type": "string"
20     }
21   ],
22   "params": {
23     "credit_id": "string",
24     "ids": [
25       "string"
26     ],
27     "limit": "100",
28     "offset": "0",
29     "plan_id": "string",
30     "plan_ids": [
31       "string"
32     ]
33   }
34 }

Authentication

X-Schematic-Api-Keystring

API Key authentication via header

Query parameters

credit_idstringOptional

plan_idstringOptional

plan_idslist of stringsOptional

idslist of stringsOptional

limitintegerOptional

Page limit (default 100)

offsetintegerOptional

Page offset (default 0)

Response

datalist of objects

paramsobject

Input parameters

Authentication

Query parameters

Response

Errors