Skip to main content

Introduction

Welcome to the Billbora API documentation! Billbora is a comprehensive invoice management platform designed for small to medium businesses, offering powerful APIs for seamless integration with your applications. Hero Light

What is Billbora?

Billbora provides a complete invoicing and payment management solution with:

Core Features

Invoice Management

Complete invoice lifecycle management from creation to payment, including:
  • Automated invoice generation
  • PDF creation and delivery
  • Payment tracking and reconciliation
  • Overdue management and reminders

Client Relationship Management

Comprehensive client management with:
  • Contact information and history
  • Invoice history and analytics
  • Payment preferences and methods
  • Communication tracking

Subscription Billing

Advanced recurring billing capabilities:
  • Flexible billing cycles and schedules
  • Usage-based billing support
  • Subscription tier management
  • Automated payment collection

Multi-Currency Support

Global business operations with:
  • Real-time exchange rates
  • Multi-currency invoicing
  • Automatic currency conversion
  • Localized formatting

Getting Started

SDK and Libraries

We provide official SDKs and libraries to make integration easier:
  • TypeScript/JavaScript
  • React Hooks
  • Python
npm install @billbora/sdk
import { BillboraAPI } from '@billbora/sdk'

const client = new BillboraAPI({
  apiKey: 'your-api-key'
})

const invoice = await client.invoices.create({
  client: 'client-id',
  line_items: [{
    description: 'Consulting Services',
    quantity: 10,
    unit_price: '150.00'
  }]
})

API Fundamentals

Base URL

All API endpoints are relative to: https://api.billbora.com/api/v1

Authentication

Billbora uses a hybrid authentication system:
  1. Supabase Authentication for user login
  2. JWT Token Exchange for API access with organization context
  3. API Keys for server-to-server integration

Rate Limits

  • General API: 1,000 requests per hour per user
  • Authentication: 10 requests per minute per IP
  • Webhooks: 50 requests per minute per endpoint

Response Format

All API responses follow a consistent JSON format:
{
  "data": {
    "id": "inv_1234567890",
    "invoice_number": "INV-001",
    "status": "draft"
  },
  "meta": {
    "request_id": "req_abc123",
    "timestamp": "2025-01-15T10:30:00Z"
  }
}

Error Handling

Errors include detailed information for debugging:
{
  "error": {
    "code": "validation_error",
    "message": "Invalid input data",
    "details": {
      "email": ["Must be a valid email address"]
    }
  },
  "meta": {
    "request_id": "req_abc123",
    "timestamp": "2025-01-15T10:30:00Z"
  }
}

Use Cases

Integrate invoicing directly into your SaaS platform:
  • Automated billing for subscriptions
  • Usage-based invoicing
  • Multi-tenant invoice management
  • White-label invoice customization
Streamline your e-commerce billing:
  • Order-to-invoice automation
  • B2B customer invoicing
  • Payment reconciliation
  • International sales support
Manage client billing for service businesses:
  • Time tracking to invoice conversion
  • Project-based billing
  • Client portal integration
  • Automated payment reminders
Handle complex marketplace transactions:
  • Split payments between vendors
  • Platform fee management
  • Vendor payout automation
  • Tax compliance per jurisdiction

Support and Community

What’s Next?

Ready to start building? Here are your next steps:
1

Get API Access

Sign up for a Billbora account and generate your API credentials
2

Follow the Quickstart

Make your first API call and create an invoice in under 5 minutes
3

Explore the SDK

Install our TypeScript SDK or React hooks for rapid development
4

Set up Webhooks

Configure real-time event notifications for your application

Ready to get started?

Follow our quickstart guide to make your first API call