v1

latestOpenAPI 3.1.0AGPLv32026-07-26168262527.5 KB
customers

Retrieve customer current and projected usage

This endpoint enables the retrieval of the usage-based billing data for a customer within the current period. It also returns the projected usage for the current period based on the current usage.

get/customers/{external_customer_id}/projected_usage

Path parameters

external_customer_idstring required
Example:5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba

The customer external unique identifier (provided by your own application).

Query parameters

external_subscription_idstring required
Example:sub_1234567890

The unique identifier of the subscription within your application.

apply_taxesboolean
Example:true

Optional flag to determine if taxes should be applied. Defaults to true if not provided or if null.

Response

Customer usage