Back to Home

API Documentation

Integrate Bill Hive with your existing tools using our powerful RESTful API. Build custom workflows, sync data, and automate your business operations.

API Version: v1 | Last updated: December 2024

Quick Start

Get started with the Bill Hive API in minutes. All endpoints use JSON.

curl https://api.billinghive.com/v1/invoices \ -H "Authorization: Bearer YOUR_API_KEY"

API Reference

Introduction

The Bill Hive API is organized around REST. Our API has predictable resource-oriented URLs, accepts JSON-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.

Base URL: https://api.billinghive.com/v1

Authentication

The Bill Hive API uses API keys to authenticate requests. You can view and manage your API keys in the Dashboard under Settings → API Keys.

// Example request
Authorization: Bearer sk_live_abc123...

Security Warning: Your API keys carry many privileges, so be sure to keep them secure! Do not share your secret API keys in publicly accessible areas.

Rate Limits

To ensure the stability of our API for all users, we enforce rate limits:

  • Free tier: 100 requests per hour
  • Pro tier: 1,000 requests per hour
  • Enterprise tier: 10,000 requests per hour

Rate limit information is included in the response headers: X-RateLimit-Limit, X-RateLimit-Remaining, and X-RateLimit-Reset.

Invoices API

Create, retrieve, update, and delete invoices programmatically.

Create an Invoice

POST /v1/invoices

List All Invoices

GET /v1/invoices

Retrieve an Invoice

GET /v1/invoices/:id

Clients API

Manage your client database programmatically.

  • POST /v1/clients - Create a new client
  • GET /v1/clients - List all clients
  • GET /v1/clients/:id - Retrieve a client
  • PUT /v1/clients/:id - Update a client
  • DELETE /v1/clients/:id - Delete a client

Payments API

Record and retrieve payment information.

  • POST /v1/payments - Record a payment
  • GET /v1/payments - List all payments
  • GET /v1/payments/:id - Retrieve a payment
  • POST /v1/payments/:id/refund - Issue a refund

Webhooks

Webhooks allow you to receive real-time notifications when events occur in your Bill Hive account.

Available Events

  • invoice.created
  • invoice.updated
  • invoice.paid
  • payment.received
  • client.created
  • proposal.signed

Error Handling

The Bill Hive API uses conventional HTTP response codes to indicate the success or failure of an API request.

  • 200 - OK - Everything worked as expected
  • 400 - Bad Request - The request was unacceptable
  • 401 - Unauthorized - Invalid API key
  • 404 - Not Found - The resource doesn't exist
  • 429 - Too Many Requests - Rate limit exceeded
  • 500 - Server Error - Something went wrong on our end

Official SDK Libraries

We offer official SDKs for popular programming languages to make integration easier.

Node.js
Python
PHP
Ruby