Documentation menu

Account

API reference

Retrieve credit balance

GET/credit

The credit balance, and the ledger entries behind it, newest first.

Each entry carries the balance after it, so any figure here can be reconciled against the charges that produced it.

Parameters

query

limitinteger
How many entries to return. Defaults to 50.

Responses

200
CreditView
Successful Response
422
ProblemDetail
The request can't be answered as sent. The code says why.

Example request

curl -X GET 'https://api.placestack.com/credit' \
  -H 'Authorization: Bearer $PLACESTACK_API_KEY'

Example response

{
  "object": "credit_balance",
  "organization_id": "<Organization Id>",
  "balance": 1,
  "included_credits": 1,
  "ledger": [
    {
      "delta": 1,
      "reason": "<Reason>",
      "balance_after": 1,
      "created_at": "2026-09-13T12:00:00Z",
      "reference": "string"
    }
  ]
}

The rest of usage.