Credits

Get credit balance

Returns the current credit balance for the authenticated user. Recommended: call this before large uploads to ensure sufficient credits. 1 credit = 1 page. Rate limit: 120 requests per minute.

get/credits

Request

  • Base URL: https://api.bankstatemently.com/v1
  • URL: https://api.bankstatemently.com/v1/credits
  • Auth: API key in header X-API-Key

Response

Current credit balance.

balanceinteger required

Current remaining credits. 1 credit = 1 page.

limitinteger nullable required

Plan allowance. 10 for free, plan-specific for paid. null when the plan has no monthly allowance (e.g. enterprise).

planId'free' | 'pro' | 'business' required

Current plan identifier.

creditsExpireAtstring date-time nullable required

When current plan credits reset, or null for plans without expiry.

Example response

{
  "balance": 47,
  "limit": 100,
  "planId": "pro",
  "creditsExpireAt": "2026-04-01T00:00:00.000Z"
}

Changes

No recorded changes to this operation across all 1 revision of this API.