Skip to main content
Build applications and services that connect to BillingServ.

​
Start here

  1. Create or copy an API key from API Settings.
  2. Follow the API overview to authenticate and make your first request.
  3. Explore the complete API reference, generated from the BillingServ OpenAPI definition.
  4. Add event-driven updates with webhooks.

​
A first request

Use your API key as a bearer token and start with a read-only customer list request:
The API returns an X-Request-ID with each response. Keep it with your integration logs so failed requests can be traced quickly.

​
Build safely

  • Use JSON request bodies and inspect the HTTP status as well as the success value.
  • Use Idempotency-Key for supported customer, invoice, and order create/update operations so retries do not repeat a successful write.
  • Read X-RateLimit-Limit and X-RateLimit-Remaining; limits are configurable by deployment.
  • Treat code as the machine-readable error category and keep request_id with the error.
See the API overview for the supported idempotent operations and response format.

​
Receive BillingServ events

Webhooks are the recommended way to react to payments, invoice changes, customer updates, orders, subscriptions, credit notes, and support activity.

​
Keep integrations maintainable

The OpenAPI document is the machine-readable contract behind the API reference. Use the documented response headers, error codes, and webhook envelope version when building client libraries or internal integrations.