Sign in

v1

latestOpenAPI 3.0.02026-07-263403911.5 MB
UsagePlanRates

View usage plan rate

Find a single usage plan rate by ID.

get/v1/UsagePlanRates/{id}

Path parameters

idinteger required

ID of the usage plan rate to view.

Response

OK

okboolean
usage_plan_rate_idinteger

Primary identifier for this usage plan rate.

plan_idinteger required

Identifier of the usage plan this rate belongs to.

descriptionstring required

Short description of this rate.

ratenumber double

The rate amount.

surchargenumber double

Additional surcharge applied on top of the rate.

initialinteger

Number of seconds/units included before increment billing begins.

incrementinteger

Billing increment, in seconds/units, applied after the initial period.

countrystring

Country code this rate applies to.

statestring

State/province this rate applies to.

areastring

Area/NPA this rate applies to.

latastring

LATA this rate applies to.

ocnstring

OCN this rate applies to.

product_type_idinteger

Product type this rate applies to.

line_typestring

Service/line type this rate applies to.

direction'OUTBOUND' | 'INBOUND' | 'BOTH'

Call direction this rate applies to.

carrier_codestring

Carrier code this rate applies to.

source_typestring

Source/external type for this rate.

start_datestring date-time

Date this rate becomes effective.

end_datestring date-time

Date this rate is no longer effective.

rounding_digitsinteger

Number of digits to round the calculated charge to.

minimum_chargenumber double

Minimum charge to apply regardless of calculated usage.

zoneinteger

Zone this rate applies to.