StatusSupportGet API keyDashboard
AccountList credit transactions (the ledger)

Account

List credit transactions (the ledger)

Use with AI

GET /v1/credit_transactions

Every change to the balance, newest first, cursor-paged: grants (free credits), purchases, hourly usage roll-ups and adjustments. Per-request detail is in GET /v1/usage. Free.

Auth: an API key with the account:read scope, or the dashboard session.

Example

cURL
curl 'https://socialtap.dev/v1/credit_transactions' \
  -H "x-api-key: $SOCIALTAP_API_KEY"

Authorizations

x-api-keystringheaderrequired

Your API key, with the account:read scope. Authentication

Query parameters

typestring

Only this kind.

One ofgrantpromopurchaseplanusageadjustment

sincestringmax 40 chars

Created at or after: RFC 3339 or a date (UTC).

untilstringmax 40 chars

Created before: RFC 3339 or a date (UTC).

limitintegermin 1max 100

Transactions per page (default 25, at most 100).

cursorstringmax 200 chars

page.next_cursor of the previous page.

Response

application/json

200

List credit transactions (the ledger)

dataobject[]

This page's items.

ShowHide 7 child fields
balance_afterinteger

The ledger's balance after this transaction. Usage is recorded hourly, so the live balance (GET /v1/account) may be lower.

created_atstring date-time

When it was recorded, RFC 3339 UTC.

creditsinteger

Credits added (positive) or spent (negative).

descriptionstring

What it was, for humans.

idstring

Transaction ID (ctx_…).

objectstring

Always credit_transaction.

One ofcredit_transaction

typestring

grant: free credits (signup) or a goodwill grant; promo: a promo code's credits; purchase: a credit pack; plan: a monthly plan's credits added, or what was left of them ended at renewal; usage: credits spent, rolled up per hour; adjustment: a correction by support, unspent credits of a refunded or disputed purchase taken back, or given back when a dispute is won. New values may be added.

One ofgrantpromopurchaseplanusageadjustment

metaobject

The shared route meta (see the API reference introduction).

pageobject
ShowHide 4 child fields
end_reasonstringnullable

Why there are no more pages; null while has_more is true. end: the list ended, or reached since/until. platform_limit: the platform stops serving further pages although the list goes on. max_pages: SocialTap's cap on pages in one walk. New values may be added. A short or empty page is not the end: only has_more false is.

One ofendplatform_limitmax_pages

has_moreboolean

True when another page exists; then next_cursor is set. An empty page with has_more true is not the end.

next_cursorstringnullable

Pass as cursor, with the same other parameters, to get the next page; null at the end.

next_cursor_expires_atstring date-timenullable

When next_cursor stops working, RFC 3339 UTC; null at the end. Don't store cursors.

400

400 Bad Request.

invalid_inputNo retry

A parameter is missing or malformed, or the link is not one this endpoint takes.

Fix the parameter named in param as the message says. For a link of the wrong kind, call an endpoint listed in details.endpoints, when there is one.

invalid_cursorNo retry

The cursor is malformed or expired, belongs to another endpoint, or came with other parameters than the request that returned it.

Repeat the original request without cursor to start the list again.

401

401 Unauthorized.

unauthorizedNo retry

The x-api-key header is missing, or its key is unknown or revoked. On the dashboard's routes: the session cookie is missing or expired.

Send a valid API key in the x-api-key header. No key yet? A person gets one at details.signup_url; an AI agent follows details.agent_auth_url.

403

403 Forbidden.

forbiddenNo retry

The API key is valid but may not make this request, and details.reason says why: the account is suspended, the key lacks the route's scope, waits for its owner to confirm it by email, has expired, or was used from an IP outside its allowlist, or a rotated key's previous secret was used for a call that needs the admin scope. A running job stops with it too when its account is suspended or the key that created it is revoked or expires. It is about the key, never the item: a private item is private_or_unavailable, also 403, so branch on the code.

Act on details.reason. suspended: contact support. scope: use a key with details.required_scope. previous_secret: use the new secret. key_pending: have the owner open the emailed link. key_expired or key_revoked: create a new key. ip_not_allowed: call from an allowed IP.

429

429 Too Many Requests.

rate_limitedYes, later

The account passed its runaway-protection ceiling: a high per-account limit that stops a broken client loop (plans have no rate limit). Requests without an API key (signup, the MCP server's tool listing and find_endpoint) are limited per IP address instead. It also stops an account whose failed requests in the last hour cost far more than its successful ones paid for: failures are free within a limit (the message says so), and successes raise it.

Wait the seconds in the retry-after header, then retry. If your steady traffic needs more, ask support to raise the ceiling; without an API key, send one.

operationId credit_transactions.list