Outbound Call Price Object#
An outbound call price returned by Look up Outbound Call Prices.
Resource type: prices.
The id is a UUID that names the price by the plan, the prefix and the routing conditions,
so it stays the same when the same price is imported again. There is no endpoint that
returns a single price by its ID.
Attributes#
Name |
Type |
Description |
|---|---|---|
category |
|
Category of the price, as the sheets of the price list in the user panel group them. Several prices of one lookup can share a category. Possible values: |
country |
|
Destination country of the prefix, by name. |
network |
|
Destination network of the prefix, by name. |
prefix |
|
Destination prefix of the plan that priced the number: the longest one covering it among the prices of the same routing conditions. |
rate |
|
Per-minute rate in USD, VAT excluded, as a decimal string that is never rounded. |
connection_fee |
|
Fee charged once per call, in USD, VAT excluded, as a decimal string. |
initial_increment |
|
First billing increment, in seconds. A call is charged for at least this long. |
recurring_increment |
|
Each following billing increment, in seconds. |
reject_calls |
|
|
next_rate |
|
Per-minute rate in USD, VAT excluded, from |
next_connection_fee |
|
Fee charged once per call, in USD, VAT excluded, from |
next_initial_increment |
|
First billing increment, in seconds, from |
next_recurring_increment |
|
Each following billing increment, in seconds, from |
effective_at |
|
When the change named by |
comment |
|
The scheduled change of the price. |
Prices are printed without rounding, with trailing zeros dropped and at least one decimal
kept, for example 0.0, 1.5 or 0.002.
A prefix answers only while its price is in effect, and only for a number whose length is within the bounds that the plan sets for that prefix.
Comment values#
Value
Description
IncreaseThe rate increases.
DecreaseThe rate decreases.
Connection fee changeThe connection fee changes.
Billing increment changeThe initial or recurring billing increment changes.
Combined values
Two or three of the changes above at once, for example
Increase and Connection fee change, orIncrease, Connection fee change, and Billing increment change.No ChangeA change is scheduled, but the next values equal the current ones.
Reject callsThe destination is going to reject calls. The
next_attributes arenull.RemovedThe price ends within 30 days, and no price of the same prefix takes over when it ends.
effective_atis the end of the price.New BreakoutA destination that currently rejects calls opens within 30 days.
nullNo change is scheduled.