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": "Standard Usage Credit",
9       "grant_reason": "plan",
10       "id": "grant_abc123xyz",
11       "quantity": 1000,
12       "quantity_remaining": 450.5,
13       "quantity_used": 549.5,
14       "renewal_enabled": true,
15       "source_label": "Rollover from 2023",
16       "updated_at": "2024-04-01T08:00:00Z",
17       "credit_icon": "https://cdn.schematichq.com/icons/credit-default.png",
18       "currency": "USD",
19       "expires_at": "2024-12-31T23:59:59Z",
20       "plan_id": "plan_premium_001",
21       "plan_name": "Premium Plan",
22       "price": {
23         "currency": "USD",
24         "external_price_id": "price_01H2XYZABC",
25         "id": "price_01H2XYZABC",
26         "interval": "month",
27         "interval_count": 1,
28         "price": 4999,
29         "provider_type": "stripe",
30         "scheme": "per_unit",
31         "nickname": "Monthly Premium Subscription",
32         "price_decimal": "49.99"
33       },
34       "renewal_period": "monthly",
35       "reserved": 50,
36       "settled": 500,
37       "source_grant_id": "grant_rollover_2023",
38       "transfers": [
39         {
40           "amount": 100,
41           "created_at": "2024-01-10T12:00:00Z",
42           "direction": "inbound",
43           "id": "transfer_001",
44           "reason": "manual adjustment",
45           "related_grant_id": "grant_abc123xyz"
46         }
47       ],
48       "valid_from": "2024-01-01T00:00:00Z",
49       "zeroed_out_date": null,
50       "zeroed_out_reason": null
51     }
52   ],
53   "params": {
54     "company_id": "c1234567890",
55     "dir": "asc",
56     "limit": 100,
57     "offset": 0,
58     "order": "created_at"
59   }
60 }

List company credit grants

List company credit grants

Authentication

Query parameters

Response

Errors

Authentication

Query parameters

Response

Errors

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": "Standard Usage Credit",
9	"grant_reason": "plan",
10	"id": "grant_abc123xyz",
11	"quantity": 1000,
12	"quantity_remaining": 450.5,
13	"quantity_used": 549.5,
14	"renewal_enabled": true,
15	"source_label": "Rollover from 2023",
16	"updated_at": "2024-04-01T08:00:00Z",
17	"credit_icon": "https://cdn.schematichq.com/icons/credit-default.png",
18	"currency": "USD",
19	"expires_at": "2024-12-31T23:59:59Z",
20	"plan_id": "plan_premium_001",
21	"plan_name": "Premium Plan",
22	"price": {
23	"currency": "USD",
24	"external_price_id": "price_01H2XYZABC",
25	"id": "price_01H2XYZABC",
26	"interval": "month",
27	"interval_count": 1,
28	"price": 4999,
29	"provider_type": "stripe",
30	"scheme": "per_unit",
31	"nickname": "Monthly Premium Subscription",
32	"price_decimal": "49.99"
33	},
34	"renewal_period": "monthly",
35	"reserved": 50,
36	"settled": 500,
37	"source_grant_id": "grant_rollover_2023",
38	"transfers": [
39	{
40	"amount": 100,
41	"created_at": "2024-01-10T12:00:00Z",
42	"direction": "inbound",
43	"id": "transfer_001",
44	"reason": "manual adjustment",
45	"related_grant_id": "grant_abc123xyz"
46	}
47	],
48	"valid_from": "2024-01-01T00:00:00Z",
49	"zeroed_out_date": null,
50	"zeroed_out_reason": null
51	}
52	],
53	"params": {
54	"company_id": "c1234567890",
55	"dir": "asc",
56	"limit": 100,
57	"offset": 0,
58	"order": "created_at"
59	}
60	}