Get credit ledger | SchematicHQ

1 import { SchematicClient } from "@schematichq/schematic-typescript-node"; 2 3 const client = new SchematicClient({ apiKey: "YOUR_API_KEY" }); 4 await client.credits.getEnrichedCreditLedger({ 5 companyId: "company_id", 6 billingCreditId: "billing_credit_id", 7 featureId: "feature_id", 8 period: "daily", 9 startTime: "start_time", 10 endTime: "end_time", 11 limit: 1, 12 offset: 1 13 });

1 { 2 "data": [ 3 { 4 "billing_credit_id": "string", 5 "company_id": "string", 6 "expired_grant_count": 1, 7 "first_transaction_at": "2024-01-15T09:30:00Z", 8 "free_grant_count": 1, 9 "grant_count": 1, 10 "last_transaction_at": "2024-01-15T09:30:00Z", 11 "manually_zeroed_count": 1, 12 "net_change": 1.1, 13 "plan_grant_count": 1, 14 "purchased_grant_count": 1, 15 "time_bucket": "2024-01-15T09:30:00Z", 16 "total_consumed": 1.1, 17 "total_granted": 1.1, 18 "transaction_count": 1, 19 "usage_count": 1, 20 "zeroed_out_count": 1, 21 "company": { 22 "id": "string", 23 "name": "string", 24 "logo_url": "string" 25 }, 26 "credit": { 27 "id": "string", 28 "name": "string", 29 "description": "string", 30 "icon": "string", 31 "plural_name": "string", 32 "singular_name": "string" 33 }, 34 "feature": { 35 "id": "string", 36 "name": "string", 37 "description": "string", 38 "icon": "string" 39 }, 40 "feature_id": "string" 41 } 42 ], 43 "params": { 44 "billing_credit_id": "string", 45 "company_id": "string", 46 "end_time": "string", 47 "feature_id": "string", 48 "limit": "100", 49 "offset": "0", 50 "period": "daily", 51 "start_time": "string" 52 } 53 }

Authentication

X-Schematic-Api-Keystring

API Key authentication via header

Query parameters

company_idstringRequired

billing_credit_idstringOptional

feature_idstringOptional

periodenumRequired

Allowed values:

start_timestringOptional

end_timestringOptional

limitintegerOptional

Page limit (default 100)

offsetintegerOptional

Page offset (default 0)

Response

datalist of objects

paramsobject

Input parameters

Authentication

Query parameters

Response

Errors