Description

Carrier Rate

REST Name
rate
Methods
list
List
create
Create
retrieve
Retrieve
update
Update
delete
Delete
Properties
Name Data Possible Values Description
digits

Type

  • string

Default

  • None

Rules

  • required
  • min_length[1]
  • max_length[30]

Digits to match

The entered numbers will be matched with the dialed number to determine which route to use.

date_start

Type

  • date

Default

  • None

Rules

  • valid_date

Start Date

Date when the carrier rate will become active. Must be entered in YYYY-MM-DD format.

suffix

Type

  • string

Default

  • None

Rules

  • alpha_dash

Suffix

Suffix to add after the dialed number.

date_end

Type

  • date

Default

  • None

Rules

  • valid_date
  • date_greater_than[today]
  • date_greater_than[date_start]

End Date

Date when the carrier rate will end. Must be entered in YYYY-MM-DD format.

lead_strip

Type

  • string

Default

  • None

Rules

  • greater_than[0]
  • less_than[29]

Strip Leading Digits

Number of digits to strip off the front off the dialed number.

trail_strip

Type

  • string

Default

  • None

Rules

  • greater_than[0]
  • less_than[29]

Strip Trailing Digits

Number of digits to strip off the trailing portion of the dialed number.

prefix

Type

  • string

Default

  • None

Rules

  • alpha_dash

Prefix

Prefix to add in front of the dialed number.

rate

Type

  • string

Default

  • None

Rules

  • required
  • decimal

Least Cost Routing Rate

The rate indicates the relative cost of the using this carrier.