Skip to main content
GET
Retrieve customer current and projected usage

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

external_customer_id
string
required

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

Example:

"5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba"

Query Parameters

external_subscription_id
string
required

The unique identifier of the subscription within your application.

Example:

"sub_1234567890"

apply_taxes
boolean
default:true

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

Example:

true

Response

Customer usage

customer_projected_usage
object
required