This API is a generic statistical query tool which can allow you to fetch the usage or usage-rate (scale of usage) over time.

 fill the gaps in the time series when no usage happened.

This API is a generic statistical query tool which can allow you to fetch the usage or usage-rate (scale of usage) over time.
Differently from the <a>usage</a> endpoint, this one does not fill the gaps in the time series when no usage happened.

Query the usage data (sparse)

body

Specify <code>gzip</code> or <code>deflate</code> to get a compressed response. Useful if your usage query returns a lot of data.

accept-encoding

x-api-key

Prefer pre-aggregated data sources. Setting this to <code>true</code> may help with performance.

minimizeFresh

Query the usage data in batch

Query the usage data in batch (sparse)

API Reference

Getting started

Language Specific SDKs

Introduction

Authorization

Create a meter

Update a meter

Get a list of meters

Get a meter by id

Delete a meter

Meter Definition

Ingest meter records

Ingest Meters

Create or update ingest schema

List 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 Meters

Query the usage data

Fetch the current customer usage-rate

Querying Reported Usage

Query raw ingested records

Querying Raw Events

Create a usage report job

List all usage report jobs

Update a usage report job

Get a usage report job

Delete a usage report job

Validate job and query

Periodic Usage Reports

Metering Cloud

Create a customer

Update a customer

List all customers

Get a customer by id

Delete a customer

Page through and search customers

Update lifecycle stage of customer

Reinstate a customer

Get customer lifecycle stage history by id

Customers

Get detailed information about your billing cloud

Get settings about your billing cloud

Update settings about your billing cloud

Account

Create or update a product item

Get all product items

Create or update a product item price

Get product item price by ID

List all product item prices

Create or update a product plan.

Get product plan by ID

List all product plans

Add a product item price to an existing plan.

Create or update an existing currency exchange rate table.

Get an existing currency exchange rate table by id.

Delete an existing, unlocked, currency exchange rate table by id.

Get the entire history of currency exchange rate tables.

Product Items

Create a product item price using a product item price template

Create or update a flat-rate-based price

Create or update a flat-rate with overages based price

Create or update a seat-based price

Create or update a usage-based price with dimensions

Create or update a max reducer, usage-based price with dimensions.

Create or update a usage-based price with no dimensions.

Create or update a max-reducer, usage-based price with no dimensions.

Create or update a volume-based price

Product Item Price Templates

Customer plans

Queries

Assign a product plan to a customer

Fetch the latest product plan of a customer

Deletes the last customer plan the user registered to (must be a future plan).

List entire history of product plans of a customer

Backdate Customer Pricing Plan

Pricing Plans

Get an invoice

List all invoices

Invoices

Get a prepaid order.

Order a one time or a recurrence prepaid card by price.

Deletes a prepaid order.

Order a one time or a recurrence prepaid card by usage.

Get the entire list of open prepaid orders that aren't expired yet.

Prepaid Orders

Extend the end time of an existing prepaid card.

Modify the start time of an existing prepaid card.

Modify the prepaid condition of an existing prepaid card.

Split a prepaid card into multiple prepaid cards based on the customer prepaid order list.

Update an external prepaid card status.

Prepaid Cards

Get the customer prepaid wallet.

Prepaid Wallet

Apply a new promotion for the customer.

Removes an active promotion from the customer's applied promotions.

Get the entire list of active promotions applied of the customer.

Customer Promotions

Get a promotion

Create or update a promotion

Delete a promotion

List all promotions

Create or update an Absolute Product Automatic Promotion

Create or update an Absolute Product Item Automatic Promotion

Create or update a Generic Item Promotion

Create or update a Generic Product Promotion

Create or update a Relative Product Automatic Promotion

Create or update a Relative Product Item Automatic Promotion

Create or update a Relative Product Item Sales Event Promotion

Create or update a Tiered Absolute Product Automatic Promotion

Create or update a Tiered Absolute Product Item Automatic Promotion

Create or update a Tiered Relative Product Automatic Promotion

Create or update an Absolute Product Sales Event Promotion

Create or update a Product Absolute Partner Discount Promotion

Create or update a Product Item Absolute Partner Discount Promotion

Create or update a Product Item Relative Partner Discount Promotion.

Create or update an Absolute Product Item Sales Event Promotion

Create or update a relative Product Partner Automatic Promotion

Create or update a Relative Product Sales Event Promotion

Create or update a Sample Currency Promotion

Create or update a Tiered Relative Product Item Automatic Promotion

Create or update a Time Limited Absolute Item Discount

Create or update a Time Limited Absolute Product Discount

Create or update a Time Limited Relative Item Discount

Create or update a Time Limited Relative Product Discount

Create or update a Time Limited Relative Product Full Discount

Create or update a Time Limited Tiered Absolute Item Discount

Create or update a Time Limited Tiered Absolute Product Discount

Create or update a Time Limited Tiered Relative Item Discount

Create or update a Time Limited Tiered Relative Product Discount

Create or update an Unconditioned Absolute Plan Promotion

Defining Promotions

List all commitments

Create or update a commitment

Create or update an Arrears Commitment with True-up

Create or update a Custom Commitment

Create or update an Installments Commitment

Create or update a Subscription Commitment

Create or update an Upfront Commitment with True Up

Customer Commitment

by rule revenue calculator

raw revenue calculator

usage cost

usage cost - batch

Billing Analysis

Calculate taxes for a customer

Validate address

List product codes

Tax Calculation

Billing Cloud

Create a notification

Get a list of notifications

Update a notification

Get a notification by id

Delete a notification

Notifications (Alerts)

Set up a webhook subscription

List current webhook subscriptions

Update a webhook subscription

Get a webhook subscription

Remove a webhook subscription

List available topics

Send a test webhook

Retry a webhook request

Webhooks

List account event logs

Get account event by id

List available filter combinations

Event Logs

Alerts and Webhooks

Download

Upload

Remove

Company Logo

Account Settings

Create a session

Session

Query the usage data scoped to the customer

Query the usage data (batch)

Usage

Query the cost data scoped to the customer

Cost

Get all invoices for the customer

Get a specific invoice for the customer

Billing

Get the customer prepaid wallet

Prepaid

Customer Portal