GET /credit · API reference

The customer's own view of the same ledger the back office reads.

Deliberately the whole ledger and not a summary: "why is my balance 812" is a question they should be able to answer without asking us.

Parameters

query

limitinteger: No description.

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"
    }
  ]
}