Skip to content

Get customer past usage

GET
/v1/customers/{external_id}/past_usage

Get past usage for completed billing periods.

external_id
required
External Id
string
external_subscription_id
required
External Subscription Id
string
periods_count
Periods Count
integer
default: 1 >= 1

Successful Response

Response Get Past Usage V1 Customers External Id Past Usage Get
Array<object>
CurrentUsageResponse
object
from_datetime
required
From Datetime
string format: date-time
to_datetime
required
To Datetime
string format: date-time
amount_cents
required
Amount Cents
string
/^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$/
currency
required
Currency
string
charges
required
Charges
Array<object>
ChargeUsage
object
billable_metric
required
BillableMetricUsage
object
code
required
Code
string
name
required
Name
string
aggregation_type
required
Aggregation Type
string
units
required
Units
string
/^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$/
amount_cents
required
Amount Cents
string
/^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$/
charge_model
required
Charge Model
string
filters
required
Filters
object
key
additional properties
string

Unauthorized – invalid or missing API key

Customer or subscription not found

Validation Error

HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object