Skip to main content
GET
/
v1
/
workspaces
/
{workspace_id}
/
billing
/
balance
Python
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)
{
  "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,
  "current_tier": "builder",
  "has_payment_method": true,
  "payment_method_last4": "4242",
  "payment_method_brand": "visa"
}

Documentation Index

Fetch the complete documentation index at: https://docs.auriko.ai/llms.txt

Use this file to discover all available pages before exploring further.

Returns the workspace credit balance, tier, and billing configuration. Requires owner role.
This endpoint uses session authentication, not API key authentication. See Authentication.
All parameters, request/response schemas, and examples are auto-generated from the OpenAPI specification.

Authorizations

​
Authorization
string
header
required

User session authentication for workspace endpoints (e.g., billing balance). Use a session JWT as the bearer token. Example: Authorization: Bearer eyJhbGciOiJIUzI1NiIs...

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

​
current_tier
string
required

Current billing tier

Example:

"builder"

​
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)

​
platform_fee_rate
string | null

Current platform fee rate as decimal string

​
tier_volume_usd
string | null

Lifetime volume in USD for tier calculation

​
next_tier_threshold_usd
string | null

Volume needed to reach next tier in USD

​
byok_monthly_cap
integer | null

Monthly BYOK request cap (null if unlimited)

​
byok_monthly_remaining
integer | null

Remaining BYOK requests this month

​
payment_method_last4
string | null

Last 4 digits of payment method

Example:

"4242"

​
payment_method_brand
string | null

Payment method brand (visa, mastercard, etc.)

Example:

"visa"