Tariff Rates
A tariff rate is one priced line within a call tariff, setting the price for a particular type of call. See Tariff and Discount Detail Records for the field reference.
Methods
Section titled “Methods”Retrieve Single Tariff Rate
Section titled “Retrieve Single Tariff Rate”/backend/api/v1/tariffDetails/ID - fetch the tariff rate with the specified ID.
List Tariff Rates
Section titled “List Tariff Rates”/backend/api/v1/tariffDetails/ - list all tariff rates.
/backend/api/v1/tariffs/ID/tariffDetails/ - list the rates belonging to the tariff with the specified ID.
Additional Query Parameters
Section titled “Additional Query Parameters”| Parameter | Type | Required | Description |
|---|---|---|---|
idAfter | integer | No | Only include rates with a higher ID |
createdSince | datetime | No | Only include rates created since the given time |
updatedSince | datetime | No | Only include rates updated since the given time |
/backend/api/v1/tariffs/ID/tariffDetails/ - add a new rate to the specified tariff. The newly-added rate will be returned.
/backend/api/v1/tariffDetails/ID - update the tariff rate with the specified ID. The modified rate will be returned.
DELETE
Section titled “DELETE”/backend/api/v1/tariffDetails/ID - delete the tariff rate with the specified ID.
Fields
Section titled “Fields”| Field | Name | Type | Description |
|---|---|---|---|
| tariff | Tariff | Text | The tariff that this rate belongs to |
| startDate | Start Date | Date | First call date this rate applies from. Leave blank for no start limit. |
| endDate | End Date | Date | Last call date this rate applies to. Leave blank for no end limit. |
| tariffType | Charge Type | Preset Value | How rates are calculated and applied for this specific rate |
| discountPlan | Discount Plan | Preset Value | Discount plan to apply to this rate |
| cost | Cost | Text | Standard rate applied for this call type and time period |
| costConnection | Connection Cost | Text | Connection charge applied to each call of this type |
| costMin | Minimum Cost | Text | Minimum charge for any call of this type |
| costMax | Maximum Cost | Text | Maximum charge for any single call of this type |
| accessCharge | Access Charge | Number | Additional access charge applied to calls of this type |
| accessChargeConnection | Access Charge (Connection) | Number | Access charge connection component |
| roundingAccessCharge | Access Charge Rounding | Preset Value | How access charges are rounded for this rate |
| surchargeMobileOrigination | Mobile Origination Surcharge | Number | Additional charge for mobile-originated calls of this type |
| surchargeMobileOriginationConnection | Mobile Origination Surcharge (Connection) | Number | Mobile origination surcharge connection component |
| surchargeRoundingMobileOrigination | Mobile Origination Surcharge Rounding | Preset Value | How mobile origination surcharges are rounded for this rate |
| surchargePayphoneOrigination | Payphone Origination Surcharge | Number | Additional charge for payphone-originated calls of this type |
| surchargePayphoneOriginationConnection | Payphone Origination Surcharge (Connection) | Number | Payphone origination surcharge connection component |
| surchargeRoundingPayphoneOrigination | Payphone Origination Surcharge Rounding | Preset Value | How payphone origination surcharges are rounded for this rate |
| surchargeCallRecording | Call Recording Surcharge | Number | Additional charge for call recording services |
| surchargeCallRecordingConnection | Call Recording Surcharge (Connection) | Number | Call recording surcharge connection component |
| surchargeRoundingCallRecording | Call Recording Surcharge Rounding | Preset Value | How call recording surcharges are rounded for this rate |
| initialCost | Initial Cost | Text | Cost applied during the initial period of a call |
| initialDuration | Initial Duration | Number | Duration of the initial charging period |
| costSecondaryConnection | Connection Cost After Initial Duration | Number | Connection cost applied after the initial duration |
| durationMin | Minimum Chargeable Duration | Number | Shortest duration that will be charged for |
| roundSeconds | Round Duration Up To Next | Number | Round call duration up to the nearest number of seconds |
| roundBytes | Round Bytes Up To Next | Number | Round data usage up to the nearest number of bytes |
| roundEvents | Round Events Up To Next | Number | Round event count up to the nearest number |
| roundPence | Round Cost Up To Next | Text | Round call cost up to the nearest number of pence |
| roundPenceAfterSurcharge | Round Cost After Surcharge Up To Next | Number | Round final cost after surcharges are applied |
| id | Tariff Detail ID | Text | The unique identifier for this tariff rate |
| callType | Call Type | Preset Value | The type of call this rate applies to |
| callTime | Call Time | Preset Value | The time period when this rate applies |