Get credit balance

import requests url = "https://api.auriko.ai/v1/workspaces/{workspace_id}/billing/balance" headers = {"Authorization": "Bearer <token>"} response = requests.get(url, headers=headers) print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}}; fetch('https://api.auriko.ai/v1/workspaces/{workspace_id}/billing/balance', options) .then(res => res.json()) .then(res => console.log(res)) .catch(err => console.error(err));

{ "balance_microdollars": 4850000, "balance_cents": 4850, "balance_dollars": "48.50", "lifetime_purchased_microdollars": 10000000, "lifetime_purchased_cents": 10000, "lifetime_used_microdollars": 5150000, "lifetime_used_cents": 5150, "auto_reload_enabled": false, "has_payment_method": true }

Authorizations

Authorization

string

header

required

API key authentication. Keys start with ak_ prefix. Example: Authorization: Bearer ak_live_xxxxxxxxxxxx

Path Parameters

workspace_id

string<uuid>

required

Workspace identifier

Response

Credit balance and billing details

balance_microdollars

integer

required

Current balance in microdollars (1 USD = 1,000,000 μ$)

balance_cents

integer

required

Current balance in cents (computed)

balance_dollars

string

required

Current balance in dollars (computed, string for precision)

Example:

"48.50"

lifetime_purchased_microdollars

integer

required

Total credits ever purchased in microdollars

lifetime_purchased_cents

integer

required

Total credits ever purchased in cents (computed)

lifetime_used_microdollars

integer

required

Total credits ever consumed in microdollars

lifetime_used_cents

integer

required

Total credits ever consumed in cents (computed)

auto_reload_enabled

boolean

required

Whether auto-reload is enabled

has_payment_method

boolean

required

Whether a payment method is on file

auto_reload_threshold_microdollars

integer | null

Balance threshold triggering auto-reload

auto_reload_threshold_cents

integer | null

Balance threshold in cents (computed)

auto_reload_amount_microdollars

integer | null

Target balance amount for auto-reload

auto_reload_amount_cents

integer | null

Target balance amount in cents (computed)

byok_monthly_cap

integer | null

Monthly BYOK request cap (null if unlimited)

byok_monthly_remaining

integer | null

Remaining BYOK requests this month