Skip to main content

Effective Rate Object

This section outlines the Effective Rate object. An effective rate is the current rate the partner has. An effective rate is a combination of a rate plan and the actual instance of assigning that rate plan to the partner.

Effective Rate Object Attributes

The fields listed in the table below will be returned in a JSON object when a successful request has been made.

AttributeData TypeDescription
assignment
read only
objectInformation about the rate assignment used to assign this rate plan to the partner. Every time a rate plan is assigned, a rate assignment record is created. Values returned in this field are:
  • active
  • assignment_sid
  • direction
  • effective_date
  • endpoint_sid
  • partner_sid
  • plan_name
  • plan_sid
  • sub_type
  • type
Refer to the table below for more information.
plan
read only
objectInformation about the rate plan associated with this rate assignment. Values returned in this field are:
  • date_created
  • name
  • owner_sid
  • plan_sid
  • type
Refer to the table below for more information.

Rate Assignment Object

AttributeData TypeDescription
active
read only
string

Whether this rate assignment is currently active or not. Values returned in this field are no and yes. This field depends on the effective_date value and on the parent partner rate assignments. The assignment becomes active at the time specified in the effective_date attribute. The assignment can be inactive in two cases: until the effective_date has occurred and if it is replaced by a succeeding rate assignment of the same type and a new effective_date.

assignment_sid
read only
string

The rate assignment secure ID.

direction
read only
string

The rate plan direction. Values returned in this field are:

  • inbound to apply the plan to received calls and messages.
  • outbound to apply the plan to sent calls and messages.
  • undirected to apply the plan to actions with no direction specified.
effective_date
read only
string

The date and time when the rate plan goes into effect.

endpoint_sid
read only
string

The secure ID of the endpoint for which this rate plan is effective. This field contains a value only if the rate assignment is of the lcr type. Otherwise it will be null.

partner_sid
read only
string

The secure ID of the partner with which this rate assignment is associated.

plan
read only
object

Information about the rate plan associated with this rate assignment. Values returned in this field are:

  • date_created
  • name
  • owner_sid
  • plan_sid
  • type
plan_name
read only
string

The rate plan name.

plan_sid
read only
string

The rate plan secure ID.

sub_type
read only
string

The rate assignment subtype that this rate plan affects.

  • For VoIP, the subtype is defined by the endpoint type (conference, conference_playback, conference_v2, flexml, mediator, peering_receiver, peering_sender, third_party, and voicemail).
  • For SMS/MMS, the subtype is defined by the from (or from_did) type (toll, toll_free, short_code).
type
read only
string

The rate assignment type. Values returned in this field are: did, event, lcr, mms, pstn, sms, sms_mms_passthrough and voip.

Rate Plan Object

AttributeData TypeDescription
date_created
read only
stringThe date and time when the rate plan was created.
name
read only
stringThe rate plan file name.
owner_sid
read only
stringThe secure ID of the partner to whom the rate plan belongs.
plan_sid
read only
stringThe rate plan secure ID.
type
read only
stringThe rate plan type. Values returned in this field are:
  • event for the rate plans that define the billable events (CNAM lookup, use of Amazon Polly TTS voices, etc.)
  • mcc_mnc for the rate plans that set pricing for sending messages.
  • phonenumber for the rate plans that set pricing for voice calls.
  • phonenumber_classification for the rate plans that can be used with the Rate DID Tier objects.
  • sms_mms_passthrough for the rate plans that set carrier pass-through fees at a global level.

Sample Effective Rate Object

{
"assignment": {
"active": "yes",
"assignment_sid": "2aa25903-6312-4c4f-9ea6-bbc7a060e142",
"direction": "inbound",
"effective_date": "2023-10-03T00:00:00.000Z",
"endpoint_sid": null,
"partner_sid": "b9Ua99icuAdvDvv2kvlNaPzMLDXwuEYJ",
"plan_name": "voice_inbound_rates-2023-10-15",
"plan_sid": "6ab7df5d-7603-4d1b-8f5e-223b7dee0c6d",
"sub_type": null,
"type": "pstn"
},
"plan": {
"date_created": "2023-10-19T14:33:07.000Z",
"name": "voice_inbound_rates-2023-10-15",
"owner_sid": "b9Ua99icuAdvDvv2kvlNaPzMLDXwuEYJ",
"plan_sid": "6ab7df5d-7603-4d1b-8f5e-223b7dee0c6d",
"type": "phonenumber"
}
}