Carrier Tariffs
A carrier tariff links a carrier to the wholesale pricing used to estimate what you expect to pay for their calls. See the Carrier Tariffs guide for how they are used.
Methods
Section titled “Methods”Retrieve Single Carrier Tariff
Section titled “Retrieve Single Carrier Tariff”/backend/api/v1/carrierTariffs/ID - fetch the carrier tariff with the specified ID.
List Carrier Tariffs
Section titled “List Carrier Tariffs”/backend/api/v1/carrierTariffs/ - list all carrier tariffs.
Additional Query Parameters
Section titled “Additional Query Parameters”| Parameter | Type | Required | Description |
|---|---|---|---|
idAfter | integer | No | Only include carrier tariffs with a higher ID |
createdSince | datetime | No | Only include carrier tariffs created since the given time |
updatedSince | datetime | No | Only include carrier tariffs updated since the given time |
/backend/api/v1/carrierTariffs/ - add a new carrier tariff. The newly-added carrier tariff will be returned.
/backend/api/v1/carrierTariffs/ID - update the carrier tariff with the specified ID. The modified carrier tariff will be returned.
DELETE
Section titled “DELETE”/backend/api/v1/carrierTariffs/ID - delete the carrier tariff with the specified ID.
Fields
Section titled “Fields”| Field | Name | Type | Description |
|---|---|---|---|
| carrier | Carrier | Preset Value | The primary carrier this tariff configuration applies to |
| callCarrier | Call Carrier | Preset Value | The specific carrier used for call routing with this configuration |
| numberType | Number Type | Preset Value | The number type this carrier tariff configuration applies to |
| inboundTariff | Inbound | Preset Value | Wholesale tariff defining buy costs for inbound calls through this carrier |
| nationalTariff | National | Preset Value | Wholesale tariff defining buy costs for national calls through this carrier |
| mobileTariff | Mobile | Preset Value | Wholesale tariff defining buy costs for mobile calls through this carrier |
| nongeographicTariff | Non-geographic | Preset Value | Wholesale tariff defining buy costs for non-geographic calls through this carrier |
| serviceNumbersTariff | Service Numbers | Preset Value | Wholesale tariff defining buy costs for service numbers through this carrier |
| internationalTariff | International | Preset Value | Wholesale tariff defining buy costs for international calls through this carrier |
| extendedInternationalTariff | Extended International | Preset Value | Wholesale tariff defining buy costs for extended international calls through this carrier |
| surchargesTariff | Surcharges | Preset Value | Wholesale tariff defining buy costs for surcharges through this carrier |
| bespokeTariff1 | Bespoke Tariff 1 | Preset Value | Wholesale tariff defining buy costs for bespoke tariff 1 through this carrier |
| bespokeTariff2 | Bespoke Tariff 2 | Preset Value | Wholesale tariff defining buy costs for bespoke tariff 2 through this carrier |
| locationLookupCarrier | Use Dial Strings For | Preset Value | Carrier to use for dial string lookups and location-based routing |
| id | Carrier Tariff ID | Text | The unique identifier for this carrier tariff configuration |