Read company credit usage transactions
/company/credit-transactionsbilling:readRead company credit usage transactions. Only explicitly granted sites and permissions are accessible. No credentials or raw worker payloads are returned. Requires explicitly delegated company-wide billing:read; business-unit-restricted integrations are rejected. No date filters or credit mutations are supported.
| Request | GET https://satelliteai.io/api/v1/company/credit-transactions |
| Permission | billing:read |
| Response | A list (cursor or offset paginated): data is array of CompanyCreditTransaction. |
| Operation ID | listCompanyCreditTransactions |
More context and worked examples are in the developer guide.
Example request
curl --fail-with-body \
'https://satelliteai.io/api/v1/company/credit-transactions' \
-H "Authorization: Bearer $SATELLITE_API_KEY"Replace the example IDs with values returned by the discovery endpoints. Example values are placeholders, not real records.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
limit | query | integer | Maximum records per page. Default 50, maximum 100. default 50 · min 1 · max 100 |
cursor | query | string | Opaque next_cursor from the prior page; expires after 24 hours. Preserve all filters. |
Unknown or repeated query parameters return 400.
Data dictionary
Scoped result. Lists return pagination metadata; unavailable records return 404. Stored credit movement. No transaction descriptions or internal metadata are exported.
[] marks an array element. nullable means the value can be null; treat it as unknown, not zero. always present means the key is always included in the object.
| Field | Type | Description |
|---|---|---|
data[].id | integernullable | Id. |
data[].amount | integernullable | Amount. |
data[].base_balance_after | integernullable | Base balance after. |
data[].addon_balance_after | integernullable | Addon balance after. |
data[].transaction_type | string | |
data[].created_at | string (date-time) | When Satellite created the record (UTC, RFC 3339). |
Response metadata
| Field | Type | Description |
|---|---|---|
meta.request_id | stringalways present | Request identifier; also returned in X-Request-ID. Include it in support requests. |
meta.api_version | stringalways present | API version that produced the response. one of: v1 |
meta.limit | integer | Applied page size; default 50, maximum 100. |
meta.has_more | boolean | Whether another page exists. |
meta.next_cursor | stringnullable | Opaque next-page cursor, null at the end. Cursors expire after 24 hours. |
meta.availability | string | available when stored data exists; not_available when it does not. one of: available, not_available |
meta.billing | object | Present for paid live SERP requests; replayed receipts describe the original debit, not an additional charge. |
meta.billing.operation | stringalways present | one of: client_api_serp_refresh |
meta.billing.credits_charged | integeralways present | min 0 |
meta.billing.transaction_id | integeralways present | |
meta.billing.replayed | booleanalways present |
Error responses
Errors return {"error": {"code", "message", "request_id"}}. See error handling for retry guidance.
| HTTP | When |
|---|---|
400 | Invalid parameters |
401 | Invalid credentials |
403 | Missing permission |
404 | Missing or inaccessible resource |