Returns the credit balance, the grants that make it up, and recent credits added or expired, newest first.
Each entry includes balance_after, the balance once it applied.
Parameters
query
- limitinteger
- Number of ledger entries to return, between 1 and 500. Defaults to 50.
Responses
- 200
- CreditView
- The credit balance.
- 401
- ProblemDetail
credential_missing,credential_invalidorcredential_expired. The request has no valid credential.- 403
- ProblemDetail
scope_missing,person_required,api_key_not_acceptedorentitlement_missing. The credential or plan does not allow this request.detailnames the reason.- 422
- ProblemDetail
parameter_invalid,id_malformedor a cursor code. A parameter is missing or invalid.errorslists each one.- 429
- ProblemDetail
rate_limited. Too many requests. Retry after theRetry-Afterinterval. Nothing is charged.
Credits
Free.
Example request
curl -X GET 'https://api.placestack.com/v1/credit' \
-H "Authorization: Bearer $PLACESTACK_API_KEY"Example response
{
"object": "credit_balance",
"organization_id": "0192f3a4-5b6c-7d8e-9f01-23456789abcd",
"balance": 1,
"included_credits": 1,
"grants": [
{
"object": "credit_grant",
"id": "cgr_01j9z3k4m5n6p7q8r9s0t1v2w3",
"amount": 1,
"remaining": 1,
"category": "paid",
"source": "signup",
"priority": 1,
"effective_at": "2026-09-13T12:00:00Z",
"expires_at": "2026-09-13T12:00:00Z",
"created_at": "2026-09-13T12:00:00Z"
}
],
"ledger": [
{
"delta": 1,
"grant": "cgr_01j9z3k4m5n6p7q8r9s0t1v2w3",
"reason": "purchase",
"reference": "evt_1Q2w3E4r5T6y7U8i",
"balance_after": 1,
"created_at": "2026-09-13T12:00:00Z"
}
]
}