Skip to main content
Cost: free
GET
/
usage
cURL
curl --request GET \
  --url https://api.workfloo.ws/v0/usage \
  --header 'x-api-key: <api-key>'
{
  "timestamp": "2025-01-01T00:00:00.000Z",
  "credits_left": 900,
  "credits_granted": 1000,
  "credits_used": 100,
  "plan": {
    "name": "Starter",
    "renewal_date": "2025-02-01T00:00:00.000Z"
  }
}
Returns the current usage for the account:
  • credits_left: credits left for the account (current balance; credits granted - credits used),
  • credits_granted: credits granted for the account (total credits granted),
  • credits_used: credits used for the account (total credits used),
  • plan: plan details (name and renewal date if applicable).
This endpoint does not affect credits, but rate limits apply.

Authorizations

​
x-api-key
string
header
required

Response

Successful response

​
timestamp
string
required

Timestamp

Example:

"2025-01-01T00:00:00.000Z"

​
credits_left
number
required

Credits left for the account (current balance; credits granted - credits used)

Example:

900

​
credits_granted
number
required

Credits granted for the account (total credits granted)

Example:

1000

​
credits_used
number
required

Credits used for the account (total credits used)

Example:

100

​
plan
object
required

Plan