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.

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:

 to represent departments, teams, or projects

 automatically or manually to enable showbacks and chargebacks

 in Amberflo to track usage and assign pricing plans

 to define the usage events you want to bill on

 using per-unit, tiered, or dimension-based pricing

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

 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:

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.

Getting started

List cloud provider ingestion configurations

API Reference

Enterprise API Reference

Introduction

Create cloud provider ingestion configuration

Update cloud provider ingestion configuration

Cloud Provider Integrations

List all business units with filtering

Create new business unit for cost allocation

Update existing business unit configuration

Retrieve specific business unit details

Business Units

List automatic allocation rules with filtering

Create automatic cost allocation rule

Update automatic allocation rule configuration

Retrieve specific automatic allocation rule

Delete automatic allocation rule permanently

Retrieve tag-scoped allocation rule details

Delete tag-specific allocation rule permanently

Query automatic cost allocation results by tag

Automatic Cost Allocation

List manual cost distribution policies

Create manual percentage-based allocation policy

Update manual cost distribution percentages

Manual Cost Allocation

List meter price configurations with filters

Create pricing model for Amberflo meter

Update meter pricing configuration

Meter Pricing

Execute detailed cost analytics query with breakdowns

Execute optimized cost query for dashboards

Query Costs

List budget configurations with time filtering

Create spending limit and threshold configuration

Update budget limits and thresholds

Retrieve specific budget configuration details

Remove budget and stop cost tracking

Budgets

Search service catalog items with pricing

Get field values for catalog search filters

Service Catalog

Amberflo API

List all meter definitions

Create a new meter

Update an existing meter definition

Get a meter by id

Delete a meter definition by ID

Meter Definition

Ingest events

Ingest Meters

List ingest schemas

Create or update ingest schema

Get ingest schema by id

Delete ingest schema by id

Custom Ingest Schema

Create or update a filtering rule

List existing filtering rules for a meter

Filtering Out Reported Meter Events

Query the usage data

Query the usage data in batch

Query the usage data (sparse)

Fetch the current customer usage-rate

Querying Reported Usage

Query raw ingested records

Querying Raw Events

Metering Cloud

List

Update

Create

Get by id

Delete by id

Quoting (CPQ)

Customers

Chargeback Rates

Chargeback Invoice

Chargeback Quotes

Alerts and Webhooks

List all customers

Update a customer

Create a customer

Page through and search customers

Get customer by id

Delete customer by id

Retrieve complete account pricing setup

Retrieve account billing settings

Update account billing settings

Account

List account product items

Product Items

Query customer plan assignments

Queries

Create custom pricing plan from template

Retrieve customer's latest product plan

Assign product plan to customer

Delete customer pricing plan

List complete history of customer product plans

Process customer product plan cancellation

Pricing Plans

Retrieve customer product invoice

List all customer invoices

Invoices

Retrieve customer prepaid order details

Create customer prepaid order by price

Delete customer prepaid order

Create customer prepaid order by usage quota

List customer active prepaid orders

Extend prepaid card expiration date

Modify prepaid card start time

Modify prepaid card usage conditions

Split prepaid card into multiple cards

Update external prepaid payment status

Prepaid Orders

Retrieve customer prepaid credit wallet

Prepaid Wallet

List payment provider settings

List customer payment method switches

Create customer payment method switch

Cancel customer payment method switches

Switching Payment Providers

Operation not supported

Apply a promotion to a customer pricing plan

Remove a promotion from a customer pricing plan

List all applied promotions on customer pricing plan

Customer Promotions

Retrieve account promotion details

Create or update account promotion

Delete account promotion

List all account promotions

Create absolute product automatic promotion

Create absolute product item automatic promotion

Create flexible promotion for specific product items

Create flexible promotion for entire products

Create relative product automatic promotion

Create relative product item automatic promotion

Create relative product item sales event promotion

Create tiered absolute product automatic promotion

Create tiered absolute product item automatic promotion

Create tiered relative product automatic promotion

Create absolute product sales event promotion

Create product absolute partner discount

Create product item absolute partner discount

Create percentage discount for partner-referred customers

Create absolute product item sales event promotion

Create relative product partner automatic promotion

Create relative product sales event promotion

Create automatic tiered percentage discount based on customer tags

Create time-limited absolute item discount

Create time-limited absolute product discount

Create time-limited relative item discount

Create time-limited relative product discount

Create time-limited full product discount

Create time-limited tiered absolute item discount

Create tiered absolute product discount with automatic expiration

Create tiered percentage item discount with automatic expiration

Create tiered percentage product discount with automatic expiration

Create fixed-amount discount for entire pricing plans

Promotions

List all commitments

Create or update a commitment

Create arrears commitment with true-up

Create custom commitment contract

Create installment-based commitment

Create subscription-based commitment

Create upfront commitment with true-up

Commitments

Calculate revenue using pricing rules

Calculate raw revenue from usage data

Calculate usage-based costs

Calculate usage costs in batch

Query usage costs, revenue and profit

Query analytics data with sparse time series

Query analytics data with detailed time series

Billing Analysis

Billing Cloud

Retrieve all notification alerts

Create real-time notification alert

Retrieve specific notification alert

Update notification alert

Delete notification alert

Notifications (Alerts)

Retrieve all webhook subscriptions

Create webhook subscription

Update webhook subscription

Retrieve specific webhook subscription

Delete webhook subscription

Retrieve available webhook topics

Webhooks