Misc

Balance

The Balance endpoint allows you to retrieve the current credit balance available in your Akowe account.

Credits are required to issue certificates, so this endpoint helps you track how many issuances you can perform.

Endpoint

GET {{baseurl}}/api/users/balance

Headers

Header
Required
Description

x-api-key

✅ Yes

Your unique API key from the Akowe dashboard.

Sample Request

curl --location '{{baseurl}}/api/users/balance' \
--header 'x-api-key: live-f512814e-9a17-4a67-a567-54f02d5c7317-0-a13c1092-e8d7-473c-b3e0-a80b50c5d672' \
--data ''

Successful Response

{
  "success": true,
  "data": {
    "balance": 6
  }
}

Notes

  • balance indicates the number of certificate issuances remaining.

  • If the balance is 0, you will need to purchase additional credits before issuing new certificates.

Balance

get
Header parameters
x-api-keystringOptionalExample: live-f512814e-9a17-4a67-a567-54f02d5c7317-0-a13c1092-e8d7-473c-b3e0-a80b50c5d672
Responses
200

Successful response

application/json
get
/api/users/balance
GET /api/users/balance HTTP/1.1
Host: {{baseurl}}
Accept: */*
200

Successful response

No content
PreviousOrganization