Every payment the account made, newest first, cursor-paged: credit packs bought at checkout, auto top-ups, and monthly plan invoices (first months, renewals, upgrades), each with what it cost, its credits, and whether it was refunded or disputed. Its receipt is GET /v1/billing/purchases/{id}/receipt. Free.
Auth: an API key with the account:read scope, or the dashboard session.
Example
curl 'https://socialtap.dev/v1/billing/purchases' \
-H "x-api-key: $SOCIALTAP_API_KEY"Response
200
List purchases
dataobject[]This page's items.
ShowHide 11 child fields
amount_refundedintegerRefunded so far, in currency's smallest unit; 0 when nothing was.
amount_totalintegernullableCharged, tax included, in currency's smallest unit; null when not recorded.
created_atstring date-timeWhen it was recorded, RFC 3339 UTC.
creditsintegerCredits it adds: the pack's, or the plan's for the month.
currencystringnullableamount_total's currency (ISO 4217, lowercase); null when not recorded.
idstringPurchase ID: the Checkout session (cs_…) of a pack, the auto top-up (atu_…), or the plan's invoice (in_…).
objectstringAlways purchase.
One ofpurchase
packstringnullableThe credit pack bought (catalog pack ID); null for a plan, or when it is not recorded.
planstringnullableThe monthly plan paid for (catalog plan ID); null for a pack, or when it is not recorded.
statusstringpending (a delayed payment, such as a bank debit, is clearing: its credits are added when it does), paid, failed (the delayed payment failed: nothing was charged or added), partially_refunded, refunded, or disputed (the cardholder's bank disputed it; a dispute closed in SocialTap's favor reads paid again).
One ofpendingpaidfailedpartially_refundedrefundeddisputed
typestringpack (a credit pack bought at checkout), auto_top_up (a pack auto top-up bought with the saved card) or plan (a monthly plan's invoice: its first month, a renewal or an upgrade).
One ofpackauto_top_upplan
metaobjectThe shared route meta (see the API reference introduction).
pageobjectShowHide 4 child fields
end_reasonstringnullableWhy 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_morebooleanTrue when another page exists; then next_cursor is set. An empty page with has_more true is not the end.
next_cursorstringnullablePass as cursor, with the same other parameters, to get the next page; null at the end.
next_cursor_expires_atstring date-timenullableWhen next_cursor stops working, RFC 3339 UTC; null at the end. Don't store cursors.
400
400 Bad Request.
invalid_inputNo retryA 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 retryThe 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 retryThe 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 retryThe 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, laterThe 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 billing.purchases.list