Balance and key limits
curl --request GET \
--url https://gateway.apiosk.com/v2/balance \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://gateway.apiosk.com/v2/balance', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"organisation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"balance": {
"available": {
"amount": 0.023,
"amount_micro_usd": "23000",
"currency": "USD"
}
},
"key": {
"id": "<string>",
"name": "<string>",
"scopes": [
"<string>"
],
"expires_at": "2023-11-07T05:31:56Z"
},
"limits": {
"per_request": {
"amount": 0.023,
"amount_micro_usd": "23000",
"currency": "USD"
},
"monthly": {
"amount": 0.023,
"amount_micro_usd": "23000",
"currency": "USD"
},
"month_spent": {
"amount": 0.023,
"amount_micro_usd": "23000",
"currency": "USD"
},
"month_remaining": {
"amount": 0.023,
"amount_micro_usd": "23000",
"currency": "USD"
},
"month_start": "2023-11-07T05:31:56Z"
}
}{
"error": {
"code": "invalid_source_input",
"message": "<string>",
"required_scope": "<string>",
"limit": "per_request",
"required": {
"amount": 0.023,
"amount_micro_usd": "23000",
"currency": "USD"
},
"available": {
"amount": 0.023,
"amount_micro_usd": "23000",
"currency": "USD"
},
"field": "<string>",
"missing": [
"<string>"
],
"expected": [
"<string>"
],
"operations": [
"<string>"
],
"retry_after_ms": 123
}
}{
"error": {
"code": "invalid_source_input",
"message": "<string>",
"required_scope": "<string>",
"limit": "per_request",
"required": {
"amount": 0.023,
"amount_micro_usd": "23000",
"currency": "USD"
},
"available": {
"amount": 0.023,
"amount_micro_usd": "23000",
"currency": "USD"
},
"field": "<string>",
"missing": [
"<string>"
],
"expected": [
"<string>"
],
"operations": [
"<string>"
],
"retry_after_ms": 123
}
}{
"error": {
"code": "invalid_source_input",
"message": "<string>",
"required_scope": "<string>",
"limit": "per_request",
"required": {
"amount": 0.023,
"amount_micro_usd": "23000",
"currency": "USD"
},
"available": {
"amount": 0.023,
"amount_micro_usd": "23000",
"currency": "USD"
},
"field": "<string>",
"missing": [
"<string>"
],
"expected": [
"<string>"
],
"operations": [
"<string>"
],
"retry_after_ms": 123
}
}{
"error": {
"code": "invalid_source_input",
"message": "<string>",
"required_scope": "<string>",
"limit": "per_request",
"required": {
"amount": 0.023,
"amount_micro_usd": "23000",
"currency": "USD"
},
"available": {
"amount": 0.023,
"amount_micro_usd": "23000",
"currency": "USD"
},
"field": "<string>",
"missing": [
"<string>"
],
"expected": [
"<string>"
],
"operations": [
"<string>"
],
"retry_after_ms": 123
}
}API Reference
Balance and key limits
Free. Requires billing:read.
GET
/
v2
/
balance
Balance and key limits
curl --request GET \
--url https://gateway.apiosk.com/v2/balance \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://gateway.apiosk.com/v2/balance', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"organisation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"balance": {
"available": {
"amount": 0.023,
"amount_micro_usd": "23000",
"currency": "USD"
}
},
"key": {
"id": "<string>",
"name": "<string>",
"scopes": [
"<string>"
],
"expires_at": "2023-11-07T05:31:56Z"
},
"limits": {
"per_request": {
"amount": 0.023,
"amount_micro_usd": "23000",
"currency": "USD"
},
"monthly": {
"amount": 0.023,
"amount_micro_usd": "23000",
"currency": "USD"
},
"month_spent": {
"amount": 0.023,
"amount_micro_usd": "23000",
"currency": "USD"
},
"month_remaining": {
"amount": 0.023,
"amount_micro_usd": "23000",
"currency": "USD"
},
"month_start": "2023-11-07T05:31:56Z"
}
}{
"error": {
"code": "invalid_source_input",
"message": "<string>",
"required_scope": "<string>",
"limit": "per_request",
"required": {
"amount": 0.023,
"amount_micro_usd": "23000",
"currency": "USD"
},
"available": {
"amount": 0.023,
"amount_micro_usd": "23000",
"currency": "USD"
},
"field": "<string>",
"missing": [
"<string>"
],
"expected": [
"<string>"
],
"operations": [
"<string>"
],
"retry_after_ms": 123
}
}{
"error": {
"code": "invalid_source_input",
"message": "<string>",
"required_scope": "<string>",
"limit": "per_request",
"required": {
"amount": 0.023,
"amount_micro_usd": "23000",
"currency": "USD"
},
"available": {
"amount": 0.023,
"amount_micro_usd": "23000",
"currency": "USD"
},
"field": "<string>",
"missing": [
"<string>"
],
"expected": [
"<string>"
],
"operations": [
"<string>"
],
"retry_after_ms": 123
}
}{
"error": {
"code": "invalid_source_input",
"message": "<string>",
"required_scope": "<string>",
"limit": "per_request",
"required": {
"amount": 0.023,
"amount_micro_usd": "23000",
"currency": "USD"
},
"available": {
"amount": 0.023,
"amount_micro_usd": "23000",
"currency": "USD"
},
"field": "<string>",
"missing": [
"<string>"
],
"expected": [
"<string>"
],
"operations": [
"<string>"
],
"retry_after_ms": 123
}
}{
"error": {
"code": "invalid_source_input",
"message": "<string>",
"required_scope": "<string>",
"limit": "per_request",
"required": {
"amount": 0.023,
"amount_micro_usd": "23000",
"currency": "USD"
},
"available": {
"amount": 0.023,
"amount_micro_usd": "23000",
"currency": "USD"
},
"field": "<string>",
"missing": [
"<string>"
],
"expected": [
"<string>"
],
"operations": [
"<string>"
],
"retry_after_ms": 123
}
}