Getting started

5 min

Welcome to the Amberflo API Documentation

Amberflo provides a robust set of APIs to help you meter usage, manage billing, allocate costs, and integrate your systems with the Amberflo platform. This documentation covers all publicly available APIs and will guide you through getting started, authenticating requests, and working with key objects.

If you run into any issues while using the APIs, please reach out to Amberflo Support for assistance.

Getting Started by Use Case

The best place to begin depends on how you’re planning to use Amberflo. Here are the most common starting points for each use case:

FinOps and Cost Allocation

Connect Cloud Accounts like AWS, Azure, GCP and more.

Create Business Units to represent departments, teams, or projects

Allocate Costs automatically or manually to enable showbacks and chargebacks

Customer Billing

Create Customers in Amberflo to track usage and assign pricing plans

Create Meters to define the usage events you want to bill on

Create a Pricing Plan using per-unit, tiered, or dimension-based pricing

API Authentication

All API requests must be authenticated using your Amberflo API key. Each environment (production, staging, etc.) has its own unique key.

To find your API key:

Navigate to Settings

Under Account Configuration, go to API Keys

Important: Be sure to use the correct API key for the environment you’re targeting. If you need to rotate or deactivate a key, please contact support.

Include the key in the x-api-key header for all API requests:

x-api-key: YOUR_API_KEY

SDKs

If you prefer to interact with Amberflo using language-specific SDKs, we offer official SDKs for several popular languages. SDKs simplify API usage, provide helpful utilities like batching, and ensure best practices out of the box.

Visit the Amberflo SDKs documentation to get started.