Rate Object
This section describes the elements of the Rate object.
Rate Object Properties
These fields and values make up the JSON object that gets returned with successful requests.
| Parameter | Data Type | Description |
|---|---|---|
| active read only | string | Whether or not that rate is effective, as determined by |
| effective_date read only | string | The date and time when the rate becomes effective. |
| items read only | array of objects | The rate details. Refer to the table below for more information. |
| partner_sid read only | string | The secure ID of the partner associated with the rate. |
| rates_plan read only | object | The rate plan. Refer to the table below for more information. |
Rate Call Object
| Parameter | Data Type | Description |
|---|---|---|
| billing_increment read only | number | The increment in seconds by which billing will occur. Calls are rounded up to the nearest |
| billing_minimum read only | number | The minimum length of the call in seconds for billing. |
| country_code read only | string | The ISO 3166-1 alpha-3 code of this rate. |
| country_name read only | string | The common country name of this rate. |
| prefix read only | string | The prefix of this call rate. |
| price read only | number | The price of this rate. The price is per |
Rate Plan Object
| Parameter | Data Type | Description |
|---|---|---|
| name read only | string | The name of the rate plan. |
| rates_plan_sid read only | string | The rate plan secure ID. |
Sample Rate Object
{
"active": "yes",
"count": 1,
"effective_date": "2024-08-23T00:00:00.000Z",
"has_more": true,
"items": [
{
"billing_increment": "60",
"billing_minimum": "60",
"country_code": null,
"country_name": null,
"prefix": null,
"price": "0.005"
}
],
"limit": 1,
"offset": 0,
"pagination": null,
"partner_sid": "99953792-bd20-4ed0-a523-8c22788f15v6",
"rates_plan": {
"name": "retail_voice_in_rates-2024-07-05",
"rates_plan_sid": "141e0b1f-ac9b-4347-bd44-cfaef65e6f93"
},
"total": 9
}
Get Inbound PSTN Rates
This request returns a list of rates for receiving calls from the PSTN.
| get | /calls/rates/inbound/pstn |
Sample
A sample GET request to get rates for inbound PSTN calls:
curl -X GET \
'https://api.carrierx.com/core/v2/calls/rates/inbound/pstn' \
-H 'Authorization: Bearer 5ebc03d6-8b2b-44ad-bf65-72d4f1491dda'
Response
200 status code with a list of Rate objects:
{
"active": "yes",
"count": 1,
"effective_date": "2024-08-23T00:00:00.000Z",
"has_more": true,
"items": [
{
"billing_increment": "60",
"billing_minimum": "60",
"country_code": null,
"country_name": null,
"prefix": null,
"price": "0.005"
}
],
"limit": 1,
"offset": 0,
"pagination": null,
"partner_sid": "99953792-bd20-4ed0-a523-8c22788f15v6",
"rates_plan": {
"name": "retail_voice_in_rates-2024-07-05",
"rates_plan_sid": "141e0b1f-ac9b-4347-bd44-cfaef65e6f93"
},
"total": 9
}
This request is enabled for Pagination, Result Filtering, and Field Filtering.
Download CSV of Inbound PSTN Rates
This request returns a CSV with the list of all rates for receiving calls from the PSTN.
| get | /calls/rates/inbound/pstn/csv |
Sample
A sample GET request to get inbound PSTN rates for a partner in the CSV format:
curl -X GET \
'https://api.carrierx.com/core/v2/calls/rates/inbound/pstn/csv' \
-H 'Authorization: Bearer 5ebc03d6-8b2b-44ad-bf65-72d4f1491dda'
Response
200 status code and a CSV download.
This request is enabled for Field Filtering.
Get Inbound VoIP Rates
This request returns a list of rates for receiving calls from VoIP, targeted by the endpoint type.
| get | /calls/rates/inbound/voip/{sub_type} |
Sample
A sample GET request to get inbound VoIP rates for calls, targeted by the subtype:
curl -X GET \
'https://api.carrierx.com/core/v2/calls/rates/inbound/voip/conference' \
-H 'Authorization: Bearer 5ebc03d6-8b2b-44ad-bf65-72d4f1491dda'
Response
200 status code with a serialized copy of the Rate object:
{
"active": "yes",
"count": 1,
"effective_date": "2023-08-29T00:00:00.000Z",
"has_more": false,
"items": [
{
"billing_increment": "60",
"billing_minimum": "60",
"country_code": null,
"country_name": null,
"prefix": null,
"price": "0"
}
],
"limit": 1000,
"offset": 0,
"pagination": null,
"partner_sid": "99953792-bd20-4ed0-a523-8c22788f15v6",
"rates_plan": {
"name": "voip_conference_in_zero_rate.txt",
"rates_plan_sid": "141e0b1f-ac9b-4347-bd44-cfaef65e6f93"
},
"total": 1
}
This request is enabled for Pagination, Result Filtering, and Field Filtering.
Path Arguments
| Parameter | Data Type | Description |
|---|---|---|
| sub_type read only | string | The rate subtype. Values accepted in this field are:
|
Download CSV of Inbound VoIP Rates
This request returns a CSV with the list of all rates for receiving calls from VoIP, targeted by the endpoint type.
| get | /calls/rates/inbound/voip/{sub_type}/csv |
Sample
A sample GET request to get inbound VoIP rates for a partner in the CSV format:
curl -X GET \
'https://api.carrierx.com/core/v2/calls/rates/inbound/voip/conference/csv' \
-H 'Authorization: Bearer 5ebc03d6-8b2b-44ad-bf65-72d4f1491dda'
Response
200 status code and a CSV download.
This request is enabled for Field Filtering.
| Parameter | Data Type | Description |
|---|---|---|
| sub_type read only | string | The rate subtype. Values accepted in this field are:
|
Get Outbound PSTN Rates
This request returns a list of rates for sending calls to the PSTN.
| get | /calls/rates/outbound/pstn |
Sample
A sample GET request to get outbound PSTN rates for calls:
curl -X GET \
'https://api.carrierx.com/core/v2/calls/rates/outbound/pstn?limit=1' \
-H 'Authorization: Bearer 5ebc03d6-8b2b-44ad-bf65-72d4f1491dda'
Response
200 status code with a serialized copy of the Rate object:
{
"active": "yes",
"count": 1,
"effective_date": "2024-08-23T00:00:00.000Z",
"has_more": true,
"items": [
{
"billing_increment": "6",
"billing_minimum": "6",
"country_code": "USA",
"country_name": "United States",
"prefix": "1207991",
"price": "0.01"
}
],
"limit": 1,
"offset": 0,
"pagination": null,
"partner_sid": "ed437757-002d-4ecc-aa5a-efdf5e50dba0",
"rates_plan": {
"name": "retail_voice_out-2024-08-16",
"rates_plan_sid": "0428d20f-7869-4cf5-aa5c-f44f99a19515"
},
"total": 110170
}
This request is enabled for Pagination, Result Filtering, and Field Filtering.
Download CSV of Outbound PSTN Rates
This request returns a CSV with the list of all rates for sending calls to the PSTN.
| get | /calls/rates/outbound/pstn/csv |
Sample
A sample GET request to get outbound PSTN rates for calls:
curl -X GET \
'https://api.carrierx.com/core/v2/calls/rates/outbound/pstn?limit=1' \
-H 'Authorization: Bearer 5ebc03d6-8b2b-44ad-bf65-72d4f1491dda'
Response
200 status code with a serialized copy of the Rate object:
{
"active": "yes",
"count": 1,
"effective_date": "2024-08-23T00:00:00.000Z",
"has_more": true,
"items": [
{
"billing_increment": "6",
"billing_minimum": "6",
"country_code": "USA",
"country_name": "United States",
"prefix": "1207991",
"price": "0.01"
}
],
"limit": 1,
"offset": 0,
"pagination": null,
"partner_sid": "ed437757-002d-4ecc-aa5a-efdf5e50dba0",
"rates_plan": {
"name": "retail_voice_out-2024-08-16",
"rates_plan_sid": "0428d20f-7869-4cf5-aa5c-f44f99a19515"
},
"total": 110170
}
This request is enabled for Field Filtering.
Get Outbound VoIP Rates
This request returns a list of rates for sending calls to VoIP, targeted by the endpoint type.
| get | /calls/rates/outbound/voip/{sub_type} |
Sample
A sample GET request to get outbound VoIP rates for calls, targeted by the subtype:
curl -X GET \
'https://api.carrierx.com/core/v2/calls/rates/outbound/voip/conference' \
-H 'Authorization: Bearer 5ebc03d6-8b2b-44ad-bf65-72d4f1491dda'
Response
200 status code with a serialized copy of the Rate object:
{
"active": "yes",
"count": 1,
"effective_date": "2023-08-29T00:00:00.000Z",
"has_more": false,
"items": [
{
"billing_increment": "60",
"billing_minimum": "60",
"country_code": null,
"country_name": null,
"prefix": null,
"price": "0"
}
],
"limit": 1000,
"offset": 0,
"pagination": null,
"partner_sid": "ed437757-002d-4ecc-aa5a-efdf5e50dba0",
"rates_plan": {
"name": "voip_conference_out_zero_rate.txt",
"rates_plan_sid": "0428d20f-7869-4cf5-aa5c-f44f99a19515"
},
"total": 1
}
This request is enabled for Pagination, Result Filtering, and Field Filtering.
Path Arguments
| Parameter | Data Type | Description |
|---|---|---|
| sub_type read only | string | The rate subtype. Values accepted in this field are:
|
Download CSV of Outbound VoIP Rates
This request returns a CSV with the list of all rates for sending calls to VoIP, targeted by the endpoint type.
| get | /calls/rates/outbound/voip/{sub_type}/csv |
Sample
A sample GET request to get outbound VoIP rates for a partner in the CSV format:
curl -X GET \
'https://api.carrierx.com/core/v2/calls/rates/outbound/voip/conference/csv' \
-H 'Authorization: Bearer 5ebc03d6-8b2b-44ad-bf65-72d4f1491dda'
Response
200 status code and a CSV download.
This request is enabled for Field Filtering.
Path Arguments
| Parameter | Data Type | Description |
|---|---|---|
| sub_type read only | string | The rate subtype. Values accepted in this field are:
|