Get projected end-of-period usage

GET

/portal/usage/projected

Project end-of-period usage based on current consumption rate.

Parameters

Query Parameters

subscription_id

required

Subscription Id

string format: uuid

token

required

Token

string

Responses

200

Successful Response

PortalProjectedUsageResponse

Projected end-of-period usage response.

object

subscription_id

required

Subscription Id

string format: uuid

period_start

required

Period Start

string format: date-time

period_end

required

Period End

string format: date-time

days_elapsed

required

Days Elapsed

integer

days_remaining

required

Days Remaining

integer

total_days

required

Total Days

integer

current_total_cents

required

Current Total Cents

string

/^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$/

projected_total_cents

required

Projected Total Cents

string

/^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$/

currency

required

Currency

string

charges

required

Charges

Array<object>

PortalProjectedUsageItem

Projected usage for a single charge at end of billing period.

object

metric_name

required

Metric Name

string

metric_code

required

Metric Code

string

current_units

required

Current Units

string

/^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$/

projected_units

required

Projected Units

string

/^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$/

current_amount_cents

required

Current Amount Cents

string

/^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$/

projected_amount_cents

required

Projected Amount Cents

string

/^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$/

charge_model

required

Charge Model

string

401

Invalid or expired portal token

404

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