curl --request GET \
--url https://paradigm.lighton.ai/api/v3/credits \
--header 'Authorization: Bearer <token>'import requests
url = "https://paradigm.lighton.ai/api/v3/credits"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://paradigm.lighton.ai/api/v3/credits', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"currency": "<string>",
"used_eur": "<string>",
"metered": true,
"limit_eur": "<string>",
"remaining_eur": "<string>",
"estimates": {}
}{
"id": null,
"code": 403,
"error": "insufficient_permissions",
"detail": "Free-tier credits are only available to companies on the free tier.",
"doc_url": "https://developers.lighton.ai/errors#insufficient_permissions"
}{
"detail": "System is under maintenance.",
"error": "service_maintenance",
"mode": "full_shutdown",
"reason": "<string>",
"started_at": "2023-11-07T05:31:56Z",
"endpoint_category_names": [
"<string>"
]
}Company free-tier credits
Returns the company’s cumulative metered-API-call spend in euros plus the free-tier budget and a per-playground-endpoint estimate of how many operations the remaining credits buy at current list price. limit_eur, remaining_eur and estimates are populated only for non-exempt companies while LIMIT_ENFORCEMENT_ENABLED is on; otherwise they are null/empty.
Free-tier only. Credits are a free-tier concept, so a company that is not on the free tier — a paid or otherwise exempt tier, or any company while LIMIT_ENFORCEMENT_ENABLED is off — receives 403 Forbidden by design. The 403 is expected, not a failure: clients should treat it as “no free-tier credits apply to this company” (e.g. hide the credits banner) rather than surfacing it as an error.
curl --request GET \
--url https://paradigm.lighton.ai/api/v3/credits \
--header 'Authorization: Bearer <token>'import requests
url = "https://paradigm.lighton.ai/api/v3/credits"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://paradigm.lighton.ai/api/v3/credits', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"currency": "<string>",
"used_eur": "<string>",
"metered": true,
"limit_eur": "<string>",
"remaining_eur": "<string>",
"estimates": {}
}{
"id": null,
"code": 403,
"error": "insufficient_permissions",
"detail": "Free-tier credits are only available to companies on the free tier.",
"doc_url": "https://developers.lighton.ai/errors#insufficient_permissions"
}{
"detail": "System is under maintenance.",
"error": "service_maintenance",
"mode": "full_shutdown",
"reason": "<string>",
"started_at": "2023-11-07T05:31:56Z",
"endpoint_category_names": [
"<string>"
]
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Response
ISO 4217 code applied to all €-value fields in the response
Cumulative cost of the company's metered API calls so far, priced at each event's version.
True when the company is on a paid/metered plan — free-tier credits do not apply.
Free-tier API-call budget for non-exempt companies. null when the company is exempt (metered/paid tier) or the LIMIT_ENFORCEMENT_ENABLED feature flag is off — the banner hides in that case.
limit_eur - used_eur, floored at 0. null whenever limit_eur is null.
How many operations the remaining credits buy, keyed by playground endpoint (parse, extract, search, ask). Empty when there is no free-tier cap.
Show child attributes
Show child attributes