Quickstart - Fluxrate

Create a Meter Feature

A meter defines what usage you want to track. Create your first meter feature through Dashboard or use the API.

Dashboard
API

Go to Dashboard > Features
Select Meter feature
Define the Meter, Type, Unit and Aggregation
Add Filters (Optional)

Note the meter_name from the feature info page, you’ll need it to send usage events.

curl -X POST https://api.fluxrate.com/api/v1/usage \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: <YOUR API KEY>' \
  -d '{
    "customer_external_id": "<CUSTOMER_UUID>",
    "meter_name": "mtr_name",
    "timestamp": "2026-01-03T12:00:00Z",
    "idempotency_key": "evt_unique_12345",
    "properties": {
      "property_name": 10,
      "filter_value": "String"
    }
  }'

Create a Plan

Plans define what customers pay and entitlements. Create a usage-based plan that charges per API call:

Dashboard
API

Go to Dashboard > Plans
Create Plan and define the Charges and Features
Charges have 2 options Recurring (Fixed charges) and Usage based charges
Set the charge in different duration with various currency
Features are where you define the plan** entitlements**

curl -X POST https://api.fluxrate.co/api/v1/plans \
  -H "Content-Type: application/json" \
  -H "Cookie: access_token=<your_token>" \
  -d '{
    "name": "Starter",
    "lookup_id": "starter",
    "type": "USAGE",
    "billing_interval": "month",
    "currency": "USD"
  }'

Define the charges:

curl -X POST https://api.fluxrate.co/api/v1/plans/<plan_id>/charges \
  -H "Content-Type: application/json" \
  -H "Cookie: access_token=<your_token>" \
  -d '{
    "type": "USAGE",
    "meter_id": "<your_meter_id>",
    "unit_price": 0.001,
    "display_name": "API Call Charge"
  }'

Create a Customer

Here you manage you customer and see their usage and current subscription.

Dashboard
API

Go to Dashboard > Customers
Create customer with basic information
Use our SDK for realtime customer sync

curl -X POST https://api.fluxrate.co/api/v1/customers \
  -H "Content-Type: application/json" \
  -H "Cookie: access_token=<your_token>" \
  -d '{
    "name": "Acme Corp",
    "email": "billing@acme.com",
    "external_id": "acme-corp-001"
  }'

Subscribe the Customer

In the subscriptions you can assign the plan to selected customer.

Dashboard
API

Go to Dashboard > Subscriptions
Select the Customer and Plan
Set the Subscription Duration and Trial period (Optional)

curl -X POST https://api.fluxrate.co/api/v1/subscriptions \
  -H "Content-Type: application/json" \
  -H "Cookie: access_token=<your_token>" \
  -d '{
    "customer_id": "<customer_id>",
    "plan_id": "<plan_id>",
    "billing_interval": "month",
    "start_date": "2025-01-01T00:00:00Z"
  }'

Generate an API Key

Go to Dashboard > API Keys
Create a key with scope (write, read or both)
Copy the API keys - it is shown only once and store it in secured place

Send Usage Events

Send usage events from your backend using the API or SDK.Verify Event on Dashboard > Usage log

curl -X POST https://api.fluxrate.com/api/v1/usage \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: <YOUR API KEY>' \
  -d '{
    "customer_external_id": "<CUSTOMER_UUID>",
    "meter_name": "mtr_name",
    "timestamp": "2026-01-03T12:00:00Z",
    "idempotency_key": "evt_unique_12345",
    "properties": {
      "property_name": 10,
      "filter_value": "String"
    }
  }'

Always pass an idempotency_key to prevent duplicate events if your request retries.

You're Billing Infra is Ready 🎉