v1

latestOpenAPI 3.1.0AGPLv32026-07-26168262527.5 KB
customers

Retrieve customer past usage

This endpoint enables the retrieval of the usage-based billing data for a customer within past periods.

get/customers/{external_customer_id}/past_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

pageinteger
Example:1

Page number.

per_pageinteger
Example:20

Number of records per page.

external_subscription_idstring required
Example:sub_1234567890

The unique identifier of the subscription within your application.

billable_metric_codestring
Example:cpu

Billable metric code filter to apply to the charge usage

periods_countinteger
Example:5

Number of past billing period to returns in the result

Response

Customer past usage