# Read test credit balance

Read the organization’s test EUR balance

`GET https://tokenlane.de/api/credits/balance`

## Authorizations

[
  [
    {
      "name": "Authorization",
      "description": "Organization management key: `Authorization: Bearer sk-tl-v1-…`. Existing `sk-eu-` keys remain valid. Required scopes are listed in `x-scopes`; gateway inference keys cannot authorize management operations.",
      "type": "http bearer",
      "location": "",
      "scopes": []
    }
  ]
]

## curl

```curl
curl --request GET \
  --url 'https://tokenlane.de/api/credits/balance' \
  --header 'Authorization: Bearer YOUR_API_KEY'
```

## node

```node
const response = await fetch("https://tokenlane.de/api/credits/balance", {
  method: "GET",
  headers: {
    "Authorization": "Bearer " + process.env.TOKENLANE_API_KEY,
  },
});
console.log(await response.text());
```

## python

```python
import os
import urllib.request

request = urllib.request.Request(
    "https://tokenlane.de/api/credits/balance",
    method="GET",
    headers={
        "Authorization": "Bearer " + os.environ["TOKENLANE_API_KEY"],
    },
)

with urllib.request.urlopen(request) as response:
    print(response.read().decode("utf-8"))
```

## vercel

```vercel
// This operation uses HTTP directly.
const response = await fetch("https://tokenlane.de/api/credits/balance", {
  method: "GET",
  headers: {
    "Authorization": "Bearer " + process.env.TOKENLANE_API_KEY,
  },
});
console.log(await response.text());
```

## Response 200: application/json

Request successful

```json
{
  "currency": "EUR",
  "amount": "YOUR_AMOUNT",
  "amountPicos": "YOUR_AMOUNTPICOS",
  "checkout": {
    "minimum": "YOUR_MINIMUM",
    "maximum": "YOUR_MAXIMUM",
    "remaining": "YOUR_REMAINING",
    "pausedUntil": "YOUR_PAUSEDUNTIL"
  },
  "heldAmountPicos": "YOUR_HELDAMOUNTPICOS",
  "bookedAmountPicos": "YOUR_BOOKEDAMOUNTPICOS",
  "pricing": {
    "basisPoints": 0,
    "fixedFee": "YOUR_FIXEDFEE",
    "minimumFee": "YOUR_MINIMUMFEE",
    "minimumAmount": "YOUR_MINIMUMAMOUNT"
  },
  "testMode": true
}
```

### s20: object

{}

- currency (required): s81

### s81: string

"EUR"

{}

- amount (required): s35

### s35: string

{}

- amountPicos (required): s35

- checkout (required): s82

### s82: object

{}

- minimum (required): s35

- maximum (required): s35

- remaining (required): s35

- pausedUntil (required): s86

### s86: string | null

date-time

{}

- heldAmountPicos (required): s35

- bookedAmountPicos (required): s35

- pricing (required): s47

### s47: object

{}

- basisPoints (required): s55

### s55: integer

{}

- fixedFee (required): s35

- minimumFee (required): s35

- minimumAmount (required): s35

- byokQuota (optional): s48

### s48: object | null

{"additionalProperties":"false"}

- month (required): s149

### s149: string

{"pattern":"\"^\\\\d{4}-\\\\d{2}$\""}

- free_limit (required): s150

### s150: integer

{"minimum":"0"}

- free_used (required): s150

- free_remaining (required): s150

- month_bytes (required): s150

- month_limit (required): s151

### s151: integer

{"exclusiveMinimum":"0"}

- day_bytes (required): s150

- day_limit (required): s151

- parallel (required): s150

- parallel_limit (required): s151

- testMode (required): s83

### s83: boolean

true

{}

## Response 401: application/json

Authentication required (missing or invalid credentials)

```json
{
  "status": 400,
  "code": "VALIDATION_ERROR",
  "message": "Request validation failed"
}
```

### s11: object

{}

- requestId (optional): s56

### s56: string

Server correlation ID for an internal error. Also returned in X-Request-Id.

uuid

{}

- status (required): s57

### s57: number

HTTP status code

{}

```json
400
```

- code (required): s58

### s58: string

Error code

{}

```json
"VALIDATION_ERROR"
```

- message (required): s59

### s59: string

Error message

{}

```json
"Request validation failed"
```

- remedy_hint (optional): s60

### s60: string

A safe, actionable remedy from the error catalog.

{}

- details (optional): s61

### s61: array

Detailed validation errors

{}

### s154: object

{}

- path (required): s179

### s179: string

Field path

{}

```json
"title"
```

- message (required): s180

### s180: string

Field error message

{}

```json
"Required"
```

## Response 403: application/json

Insufficient scope (authenticated but not authorized)

```json
{
  "status": 400,
  "code": "VALIDATION_ERROR",
  "message": "Request validation failed"
}
```

## Response 409: application/json

Read and accept the currently published terms before continuing with this session

```json
{
  "status": 400,
  "code": "VALIDATION_ERROR",
  "message": "Request validation failed"
}
```

## Response 500: application/json

Internal server error

```json
{
  "status": 400,
  "code": "VALIDATION_ERROR",
  "message": "Request validation failed"
}
```
