Billing

API Reference

Comprehensive Backend API Documentation

Swagger UI

Interactive API documentation powered by OpenAPI specification. Test endpoints directly from your browser.

OpenAPI Version: 3.0.3

⚡ Always available - 24/7 documentation access

Server Selection

Next.js API Routes (Recommended)
http://localhost:3000/api
✓ Always available with dev server
Mock Server (Direct)
http://localhost:5001
Requires mock server running

Interactive API Documentation

Loading API Documentation...

C

Contracts

Manage billing contracts and agreements

$

Credits

Grant and manage billing credits

M

Metering

Send usage data for billing calculation

P

Payments

Process payments and manage transactions

B

Batch

Batch job operations and monitoring

1

Recommended: Next.js API Routes

  • ✓Already running with npm run dev
  • ✓No additional server needed
  • ✓CORS automatically handled

How to use:

  1. Select "Next.js API Routes" in Swagger UI dropdown
  2. Click "Try it out" on any endpoint
  3. Add uuid: test-uuid-001 header
  4. Click "Execute"
2

Alternative: Mock Server Direct

  • •Direct access to backend logic
  • •Requires separate server process
  • •Additional endpoints available

Start Mock Server:

cd mock_server
python run_server.py

Then select "Mock Server (Direct)" in dropdown

Important Notes

Authentication

  • • All endpoints require uuid header
  • • Test UUID: test-uuid-001
  • • Each request needs this header for routing

Server Dropdown

  • • Located at top of Swagger UI
  • • Switch between Next.js and Mock Server
  • • Default: Next.js API Routes (Port 3000)