> For the complete documentation index, see [llms.txt](https://documentation.akowe.app/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://documentation.akowe.app/api-reference/reference/misc.md).

# 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

```bash
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

```json
{
  "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.

***

## GET /api/users/balance

> Balance

````json
{"openapi":"3.0.0","info":{"title":"Akowe Issuance API Endpoints","version":"1.0.0"},"tags":[{"name":"Misc","description":"## Balance\n\nThe **Balance** endpoint allows you to retrieve the current credit balance available in your Akowe account.  \n  \nCredits are required to issue certificates, so this endpoint helps you track how many issuances you can perform.\n\n### Endpoint\n\n```\nGET {{baseurl}}/api/users/balance\n\n ```\n\n### Headers\n\n| Header | Required | Description |\n| --- | --- | --- |\n| `x-api-key` | ✅ Yes | Your unique API key from the Akowe dashboard. |\n\n### Sample Request\n\n``` bash\ncurl --location '{{baseurl}}/api/users/balance' \\\n--header 'x-api-key: live-f512814e-9a17-4a67-a567-54f02d5c7317-0-a13c1092-e8d7-473c-b3e0-a80b50c5d672' \\\n--data ''\n\n ```\n\n### Successful Response\n\n``` json\n{\n  \"success\": true,\n  \"data\": {\n    \"balance\": 6\n  }\n}\n\n ```\n\n### Notes\n\n- `balance` indicates the number of certificate issuances remaining.\n    \n- If the balance is `0`, you will need to purchase additional credits before issuing new certificates.\n    \n\n---"}],"servers":[{"url":"http://{{baseurl}}"}],"paths":{"/api/users/balance":{"get":{"tags":["Misc"],"summary":"Balance","parameters":[{"name":"x-api-key","in":"header","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{}}}}}}}}
````