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

enum

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: International Origin based Local

country

string

Destination country of the prefix, by name. null when the prefix is not attributed to a country.

network

string

Destination network of the prefix, by name. null when the prefix is not attributed to a network.

prefix

string

Destination prefix of the plan that priced the number: the longest one covering it among the prices of the same routing conditions.

rate

string

Per-minute rate in USD, VAT excluded, as a decimal string that is never rounded. null when reject_calls is true.

connection_fee

string

Fee charged once per call, in USD, VAT excluded, as a decimal string. null when reject_calls is true.

initial_increment

integer

First billing increment, in seconds. A call is charged for at least this long.

recurring_increment

integer

Each following billing increment, in seconds.

reject_calls

boolean

true when the plan rejects calls to this destination instead of pricing them. rate and connection_fee are then null. A rejection is an answer, not a missing price.

next_rate

string

Per-minute rate in USD, VAT excluded, from effective_at on. null when no change is scheduled, when the price is removed, or when the destination is going to reject calls.

next_connection_fee

string

Fee charged once per call, in USD, VAT excluded, from effective_at on. null whenever next_rate is null.

next_initial_increment

integer

First billing increment, in seconds, from effective_at on. null whenever next_rate is null. For a rejected destination that is about to open, the increment it opens with.

next_recurring_increment

integer

Each following billing increment, in seconds, from effective_at on. null whenever next_rate is null. For a rejected destination that is about to open, the increment it opens with.

effective_at

DateTime

When the change named by comment takes effect. null when no change is scheduled.

comment

string

The scheduled change of the price. null when no change is scheduled. See Comment values.

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

Increase

The rate increases.

Decrease

The rate decreases.

Connection fee change

The connection fee changes.

Billing increment change

The initial or recurring billing increment changes.

Combined values

Two or three of the changes above at once, for example Increase and Connection fee change, or Increase, Connection fee change, and Billing increment change.

No Change

A change is scheduled, but the next values equal the current ones.

Reject calls

The destination is going to reject calls. The next_ attributes are null.

Removed

The price ends within 30 days, and no price of the same prefix takes over when it ends. effective_at is the end of the price.

New Breakout

A destination that currently rejects calls opens within 30 days.

null

No change is scheduled.