List company credit grants

GET

https://api.schematichq.com/billing/credits/grants/company/list

GET

/billing/credits/grants/company/list

1 import { SchematicClient } from "@schematichq/schematic-typescript-node";
2 
3 const client = new SchematicClient({ apiKey: "YOUR_API_KEY" });
4 await client.credits.listCompanyGrants({
5     companyId: "company_id",
6     order: "created_at",
7     dir: "asc",
8     limit: 1,
9     offset: 1
10 });

Try it

1 {
2   "data": [
3     {
4       "company_id": "string",
5       "company_name": "string",
6       "created_at": "2024-01-15T09:30:00Z",
7       "credit_id": "string",
8       "credit_name": "string",
9       "grant_reason": "string",
10       "id": "string",
11       "quantity": 1,
12       "quantity_remaining": 1.1,
13       "quantity_used": 1.1,
14       "source_label": "string",
15       "updated_at": "2024-01-15T09:30:00Z",
16       "credit_icon": "string",
17       "expires_at": "2024-01-15T09:30:00Z",
18       "plan_id": "string",
19       "plan_name": "string",
20       "price": {
21         "currency": "string",
22         "external_price_id": "string",
23         "id": "string",
24         "interval": "string",
25         "price": 1,
26         "scheme": "string",
27         "price_decimal": "string"
28       },
29       "valid_from": "2024-01-15T09:30:00Z",
30       "zeroed_out_date": "2024-01-15T09:30:00Z",
31       "zeroed_out_reason": "string"
32     }
33   ],
34   "params": {
35     "company_id": "string",
36     "dir": "asc",
37     "limit": "100",
38     "offset": "0",
39     "order": "created_at"
40   }
41 }

Authentication

X-Schematic-Api-Keystring

API Key authentication via header

Query parameters

company_idstringOptional

orderenumOptional

Allowed values:

direnumOptional

Allowed values:

limitintegerOptional

Page limit (default 100)

offsetintegerOptional

Page offset (default 0)

Response

datalist of objects

paramsobject

Input parameters

Authentication

Query parameters

Response

Errors