Docs

Get cost info for rented numbers

https://api.apifonica.com/v2/accounts/{accountSID}/balance/numbers

Overview

This request returns a list of all phone numbers you have rented along with the payment information relating to these numbers including their setup price, monthly fee, billing day.

Pagination is supported.

Request example

The following example demonstrates checking the current account balance.

curl –X GET ‘https://api.apifonica.com/v2/accounts/{accountSID}/balance/numbers’ \
-u {accountSID}:{authToken}

Response example

{
  "limit": 20,
  "prev": null,
  "next": null,
  "account_sid": "{accountSID}",
  "numbers": [
    {
      "number_sid": "{numberSID}",
      "number": "48732231452",
      "created": "Sun, 31 January 2016 10:15:35 +0000",
      "billing_day": "Sun, 31 January 2016 10:15:35 +0000",
      "monthly_price": 1.86,
      "setup_price": 1.86,
      "currency": "eur",
      "country_name": "Poland",
      "type": "mobile"
    },
    {...}
  ]
}

Response parameters

Parameter

Description

limit

A parameter describing how many records are returned at once.

The default and maximum value is 20.

prev

URI to the previous page.

next

URI to the next page.

account_sid

Account SID.

numbers

List of rented numbers:

numbers/number_sid

Unique number identifier.

numbers/number

Number.

numbers/created

Date and time this number was rented from Apifonica.

numbers/billing_day

Day of the month this number is billed.

numbers/monthly_price

Monthly fee for this number.

numbers/setup_price

Setup price. Is taken once when the number is being rented.

numbers/currency

Currency (default - EUR).

numbers/country_name

Full name of the country.

numbers/type

Type of number.

One of the following values: local, mobile or sip.

Description

A parameter describing how many records are returned at once.

The default and maximum value is 20.

Description

URI to the previous page.

Description

URI to the next page.

Description

Account SID.

Description

List of rented numbers:

Description

Unique number identifier.

Description

Number.

Description

Date and time this number was rented from Apifonica.

Description

Day of the month this number is billed.

Description

Monthly fee for this number.

Description

Setup price. Is taken once when the number is being rented.

Description

Currency.

Description

Full name of the country.

Description

Type of number.

One of the following values:localmobiletoll-free orvirtual.