Skip to main content

Endpoints

MethodPathWhat it does
GET/billing/balanceCurrent credit balance
POST/billing/topupInitiate a top-up (Stripe)
GET/billing/transactionsTransaction history
POST/billing/subscriptions/create-checkoutSubscription checkout
GET/billing/subscriptions/statusSubscription status
POST/billing/subscriptions/portalCustomer portal session
POST/billing/subscriptions/cancelCancel subscription

Balance

GET /billing/balance
curl -sS "https://api.omium.ai/api/v1/billing/balance" \
  -H "X-API-Key: $OMIUM_API_KEY"
Response:
{
  "credits_balance": 10000,
  "balance_usd": 100.0
}

Transactions

GET /billing/transactions
curl -sS "https://api.omium.ai/api/v1/billing/transactions?page=1&page_size=50" \
  -H "X-API-Key: $OMIUM_API_KEY"

Top-up

POST /billing/topup
curl -sS "https://api.omium.ai/api/v1/billing/topup" \
  -H "X-API-Key: $OMIUM_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "amount_cents": 2000 }'

Subscription management

These endpoints are typically used by the dashboard. If you’re building your own billing UI, start with checkout + portal.
  • POST /billing/subscriptions/create-checkout
  • GET /billing/subscriptions/status
  • POST /billing/subscriptions/portal
  • POST /billing/subscriptions/cancel

Next steps

API keys & billing

Manage keys and review usage in the dashboard.

Automations

See per-run cost and health.