Get credit ledger | SchematicHQ

import { SchematicClient } from "@schematichq/schematic-typescript-node";
async function main() {
    const client = new SchematicClient({
        apiKey: "YOUR_API_KEY_HERE",
    });
    await client.credits.getEnrichedCreditLedger({
        companyId: "c1234567-89ab-4def-0123-456789abcdef",
        period: "daily",
        billingCreditId: "bc9876543-21fe-4dcb-8765-4321fedcba98",
        featureId: "f4567890-abcd-1234-ef56-7890abcdef12",
        startTime: "2024-04-01T00:00:00Z",
        endTime: "2024-04-30T23:59:59Z",
        limit: 100,
        offset: 0,
    });
}
main();

{
  "data": [
    {
      "billing_credit_auto_topup_grant_count": 5,
      "billing_credit_id": "bc9876543-21fe-4dcb-8765-4321fedcba98",
      "company_id": "c1234567-89ab-4def-0123-456789abcdef",
      "expired_grant_count": 2,
      "first_transaction_at": "2024-04-01T08:00:00Z",
      "free_grant_count": 10,
      "grant_count": 50,
      "last_transaction_at": "2024-04-30T18:45:00Z",
      "manually_zeroed_count": 0,
      "net_change": 12.5,
      "plan_grant_count": 30,
      "purchased_grant_count": 10,
      "time_bucket": "2024-04-15T00:00:00Z",
      "total_consumed": 37.5,
      "total_granted": 50,
      "transaction_count": 15,
      "usage_count": 40,
      "zeroed_out_count": 1,
      "company": {
        "id": "c1234567-89ab-4def-0123-456789abcdef",
        "name": "Acme Corporation",
        "logo_url": "https://cdn.schematichq.com/logos/company123.png"
      },
      "credit": {
        "id": "bc9876543-21fe-4dcb-8765-4321fedcba98",
        "name": "API Call Credit",
        "description": "Monthly API call credits",
        "icon": "https://cdn.schematichq.com/icons/api-credit.svg",
        "plural_name": "API Call Credits",
        "singular_name": "API Call Credit"
      },
      "feature": {
        "id": "f4567890-abcd-1234-ef56-7890abcdef12",
        "name": "Advanced Analytics",
        "description": "Access to advanced analytics feature",
        "icon": "https://cdn.schematichq.com/icons/analytics.svg"
      },
      "feature_id": "f4567890-abcd-1234-ef56-7890abcdef12"
    }
  ],
  "params": {
    "billing_credit_id": "bc9876543-21fe-4dcb-8765-4321fedcba98",
    "company_id": "c1234567-89ab-4def-0123-456789abcdef",
    "end_time": "2024-04-30T23:59:59Z",
    "feature_id": "f4567890-abcd-1234-ef56-7890abcdef12",
    "limit": 100,
    "offset": 0,
    "period": "daily",
    "start_time": "2024-04-01T00:00:00Z"
  }
}

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

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