Fixed fee tariffs centralise pricing for non-usage charges such as line rentals, installations and recurring service fees. See Fixed Fee Tariffs for full details on how fixed fee tariffs work.
Methods
GET
Retrieve Single Fixed Fee Tariff
/backend/api/v1/fixedFeeTariffs/ID - fetch fixed fee tariff with specified ID.
List Fixed Fee Tariffs
/backend/api/v1/fixedFeeTariffs/ - list all fixed fee tariffs.
POST
/backend/api/v1/fixedFeeTariffs/ - create a new fixed fee tariff. The newly-created fixed fee tariff will be returned.
PATCH
/backend/api/v1/fixedFeeTariffs/ID - update fixed fee tariff with specified ID. The modified fixed fee tariff will be returned.
DELETE
/backend/api/v1/fixedFeeTariffs/ID - delete fixed fee tariff with specified ID.
Note: A fixed fee tariff can only be deleted if it is not currently in use.
Actions
Actions are called by sending a POST request to /backend/api/v1/fixedFeeTariffs/ID/actionName.
applyIncrease
Applies a percentage price increase to the fixed fee tariff in-place. Requires expert level 5 access.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
increasePercent |
numeric | Yes | Percentage increase (e.g. 3.5) |
increaseScope |
string | Yes | recurringOnly or recurringAndConnections |
Example:
curl -X POST \
https://YOUR-DOMAIN/backend/api/v1/fixedFeeTariffs/456/applyIncrease \
-H "Authorization: Bearer YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"increasePercent": 5.0,
"increaseScope": "recurringOnly"
}'
Returns the updated fixed fee tariff.
createIncreaseVersion
Creates a new fixed fee tariff with prices increased by the specified percentage. The original fixed fee tariff is not modified.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
increasePercent |
numeric | Yes | Percentage increase (e.g. 3.5) |
increaseScope |
string | Yes | recurringOnly or recurringAndConnections |
Example:
curl -X POST \
https://YOUR-DOMAIN/backend/api/v1/fixedFeeTariffs/456/createIncreaseVersion \
-H "Authorization: Bearer YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"increasePercent": 5.0,
"increaseScope": "recurringOnly"
}'
Returns the new fixed fee tariff. If a version with the same source, percentage, and scope already exists, the existing version is returned.
See Price Increases for full details on scope options and usage guidance.
Fields
| Field | Name | Type | Description |
|---|---|---|---|
| name | Fixed Fee Tariff Name | Text | The name of the fixed fee tariff |
| description | Description | Text | Optional description of the fixed fee tariff |
| availability | Tariff Availability | Preset Value | The availability status of this fixed fee tariff |
| retail | Retail Tariff | Preset Value | Whether this is a retail or wholesale tariff |
| currency | Currency | Preset Value | The currency for this fixed fee tariff (if different from default) |
| customerID | Customer | Text | The ID of the customer this fixed fee tariff is for |
| customerGroups | Customer Groups | Text | The customer groups that can use this fixed fee tariff |
| wholesaleForCarrierIDs | Wholesale For | Preset Value(s) | The carriers this wholesale fixed fee tariff applies to |
| parentFixedFeeTariff | Based Upon | Text | The ID of the parent fixed fee tariff this tariff is based upon |
| increaseOriginalID | Original Fixed Fee Tariff | Preset Value | Fixed fee tariff this increase was based upon (self for in-place increases) |
| increasePercent | Increase % | Number | Increase percentage applied to this fixed fee tariff |
| id | Fixed Fee Tariff ID | Text | The unique identifier for this fixed fee tariff |