Credits

Get the credit balance

Returns the workspace's credit wallet. A wallet is created empty on first use, so a new workspace sees zeros rather than an error; a workspace on a free trial sees its one-time trial credits, which its first balance read hands over. unlimited is true when Emailchaser has made this workspace's credits free: credit actions then never spend available and are never refused for lack of credits, so there is no need to check the balance or buy credits.

get/credits/balance

Request

Base URL: https://api.emailchaser.com/r
URL: https://api.emailchaser.com/r/credits/balance
Auth: HTTP bearer

Response

The wallet snapshot

availableinteger

lifetimeGrantedinteger

lifetimeUsedinteger

monthlyGrantinteger

reservedinteger

unlimitedboolean

Unlimited is true when this workspace's credits are free: every credit action goes through without spending available, nothing is refused for lack of credits, and POST /credits/purchase is refused (code credits_free) because there is nothing to buy.

Example response

{
  "available": 1500,
  "lifetimeGranted": 5000,
  "lifetimeUsed": 3400,
  "monthlyGrant": 2000,
  "reserved": 100
}

Changes

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