Get customer projected usage

GET

/v1/customers/{external_id}/projected_usage

Get projected usage for a customer’s subscription.

Parameters

Path Parameters

external_id

required

External Id

string

Query Parameters

subscription_id

required

Subscription Id

string

Responses

200

Successful Response

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

401

Unauthorized – invalid or missing API key

404

Customer or subscription not found

422

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