Fixed Fee Tariff Rates
A fixed fee tariff rate is one chargeable item within a fixed fee tariff, such as line rental or broadband at a set monthly price. See Tariff and Discount Detail Records for the field reference.
Methods
Section titled “Methods”Retrieve Single Fixed Fee Tariff Rate
Section titled “Retrieve Single Fixed Fee Tariff Rate”/backend/api/v1/fixedFeeTariffDetails/ID - fetch the rate with the specified ID.
List Fixed Fee Tariff Rates
Section titled “List Fixed Fee Tariff Rates”/backend/api/v1/fixedFeeTariffDetails/ - list all fixed fee tariff rates.
/backend/api/v1/fixedFeeTariffs/ID/fixedFeeTariffDetails/ - list the rates belonging to the fixed fee 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/fixedFeeTariffs/ID/fixedFeeTariffDetails/ - add a new rate to the specified fixed fee tariff. The newly-added rate will be returned.
/backend/api/v1/fixedFeeTariffDetails/ID - update the rate with the specified ID. The modified rate will be returned.
DELETE
Section titled “DELETE”/backend/api/v1/fixedFeeTariffDetails/ID - delete the rate with the specified ID.
Fields
Section titled “Fields”| Field | Name | Type | Description |
|---|---|---|---|
| description | Description | Text | Optional description for this fixed fee rate |
| startDate | Start Date | Date | First transaction start date this fixed fee rate applies from. Leave blank for no start limit. |
| endDate | End Date | Date | Last transaction start date this fixed fee rate applies to. Leave blank for no end limit. |
| numberTypeIDs | Number Types | Preset Value(s) | The number types this fixed fee rate applies to |
| serviceTypeIDs | Service Types | Preset Value(s) | The service types this fixed fee rate applies to |
| featureTypeIDs | Feature Types | Preset Value(s) | The feature types this fixed fee rate applies to |
| transactionTypeIDs | Transaction Types | Preset Value(s) | The transaction types this fixed fee rate applies to |
| carrierIDs | Carriers | Preset Value(s) | The carriers this fixed fee rate applies to |
| fixedFeeTariffType | Charge Type | Preset Value | The type of charge calculation for this fixed fee rate |
| fixedFeeValue | Cost | Currency | The cost value for this fixed fee rate (amount or percentage depending on charge type) |
| fixedFeePeriod | Charge Period | Preset Value | The billing period for this fixed fee rate |
| fixedFeeCommissionProfile | Commission Profile | Preset Value | The commission profile to use for transactions using this fixed fee rate |
| fixedFeeTransactionCode | Transaction Code | Text | Optional transaction code for transactions using this fixed fee rate |
| discountPlanAllowancePoolName | Allowance Pool Name | Text | Name of the allowance pool which should be filled |
| discountPlanMultiplier1 | Discount Plan 1 Multiplier | Number | Multiplier for discount plan 1 |
| discountPlan1 | Discount Plan 1 | Preset Value | First discount plan that applies to this fixed fee rate |
| discountPlanMultiplier2 | Discount Plan 2 Multiplier | Number | Multiplier for discount plan 2 |
| discountPlan2 | Discount Plan 2 | Preset Value | Second discount plan that applies to this fixed fee rate |
| discountPlanMultiplier3 | Discount Plan 3 Multiplier | Number | Multiplier for discount plan 3 |
| discountPlan3 | Discount Plan 3 | Preset Value | Third discount plan that applies to this fixed fee rate |
| discountPlanMultiplier4 | Discount Plan 4 Multiplier | Number | Multiplier for discount plan 4 |
| discountPlan4 | Discount Plan 4 | Preset Value | Fourth discount plan that applies to this fixed fee rate |
| id | Fixed Fee Tariff Detail ID | Text | The unique identifier for this fixed fee tariff rate |
| fixedFeeTariff | Fixed Fee Tariff | Text | The ID of the fixed fee tariff this rate belongs to |