Get Effective Rates for Partner

This request returns all currently effective rates for a specific partner.

get	/partners/{partner_sid}/effective_rates

Sample

A sample GET request to get the partner's effective rates:

curl -X GET \
'https://api.carrierx.com/core/v2/partners/b9Ua99icuAdvDvv2kvlNaPzMLDXwuEYJ/effective_rates' \
-H 'Authorization: Bearer 5ebc03d6-8b2b-44ad-bf65-72d4f1491dda'

Response

200 status code with a list of Effective Rate objects:

{
    "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"
    }
}

This request is enabled for Field Filtering.

Required Scopes

To get information about the Effective Rates, the partner must have one of the following scopes enabled:

• partners.manage
• partners.read

Path Arguments

Parameter	Data Type	Description
partner_sid required	string	The secure ID of the partner whose rate plans will be returned.