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.
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_increment.
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 billing_minimum.

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
}