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 async function main() {
4     const client = new SchematicClient({
5         apiKey: "YOUR_API_KEY_HERE",
6     });
7     await client.credits.listCompanyGrants({});
8 }
9 main();

1 {
2   "data": [
3     {
4       "company_id": "c1234567890",
5       "company_name": "Acme Corporation",
6       "created_at": "2024-01-15T09:30:00Z",
7       "credit_id": "crd_987654321",
8       "credit_name": "Monthly Usage Credit",
9       "grant_reason": "plan",
10       "id": "grant_0011223344",
11       "quantity": 1000,
12       "quantity_remaining": 450.5,
13       "quantity_used": 549.5,
14       "renewal_enabled": true,
15       "source_label": "Subscription Renewal",
16       "updated_at": "2024-04-01T08:00:00Z",
17       "credit_icon": "https://cdn.schematichq.com/icons/credit.svg",
18       "currency": "USD",
19       "expires_at": "2024-12-31T23:59:59Z",
20       "plan_id": "plan_premium_2024",
21       "plan_name": "Premium Plan",
22       "price": {
23         "currency": "USD",
24         "external_price_id": "price_abc123",
25         "id": "price_001",
26         "interval": "month",
27         "price": 5000,
28         "provider_type": "stripe",
29         "scheme": "per_unit",
30         "price_decimal": "50.00"
31       },
32       "renewal_period": "monthly",
33       "transfers": [
34         {
35           "amount": 100,
36           "created_at": "2024-01-10T12:00:00Z",
37           "direction": "inbound",
38           "id": "transfer_abc123",
39           "reason": "top-up",
40           "related_grant_id": "grant_0011223344"
41         }
42       ],
43       "valid_from": "2024-01-01T00:00:00Z"
44     }
45   ],
46   "params": {
47     "company_id": "c1234567890",
48     "dir": "asc",
49     "limit": 100,
50     "offset": 0,
51     "order": "created_at"
52   }
53 }

Authentication

X-Schematic-Api-Keystring

API Key authentication via header

Query parameters

company_idstringOptional

orderenumOptional

Allowed values:

direnumOptional

Allowed values:

limitlongOptional

Page limit (default 100)

offsetlongOptional

Page offset (default 0)

Response

datalist of objects

paramsobject

Input parameters

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error