List credit activity

GET

https://api.schematichq.com/company/credits/ledger

GET

/company/credits/ledger

const url = 'https://api.schematichq.com/company/credits/ledger';
const options = {method: 'GET', headers: {'X-Schematic-Api-Key': '<apiKey>'}};
try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

{
  "data": {
    "entries": [
      {
        "amount": 1.1,
        "credit": {
          "id": "string",
          "name": "string",
          "plural_name": "string",
          "singular_name": "string"
        },
        "event_at": "2024-01-15T09:30:00Z",
        "id": "string",
        "kind": "adjustment",
        "bundle": {
          "id": "string",
          "name": "string"
        },
        "feature": {
          "id": "string",
          "name": "string"
        },
        "grant_reason": "adjustment",
        "usage_reason": "inference",
        "user": {
          "id": "string",
          "name": "string"
        },
        "zeroed_out_reason": "customer_archived"
      }
    ],
    "next_cursor": "string"
  },
  "params": {
    "credit_ids": [
      "string"
    ],
    "cursor": "string",
    "include_grants": true,
    "limit": 20
  }
}

The company’s credit activity, newest first: draws by feature and user, grants, and credits removed when they expired or reset. A draw written against several grants is one entry. Pass the response’s next_cursor as cursor to read the next page.

Authentication

X-Schematic-Api-Keystring

A temporary access token in the X-Schematic-Api-Key header. Your server mints it with POST /temporary-access-tokens on the secret-key API for a company, optionally for one of its users, and hands it to the page. The token fixes the company every request reads and writes.

Query parameters

credit_idslist of stringsOptional

Only entries for these credits. All credits when omitted.

cursorstringOptional<=512 characters

The previous page’s next_cursor. The newest page when omitted.

include_grantsbooleanOptional

Include grants and expiries alongside draws. Default true.

limitlongOptional1-250

Entries per page (default 100).

Response

dataobject

paramsobject

Input parameters

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error