Tariff [APIs]
Tariff
Tariffs define pricing rules for services and are linked to Ratezones. Tariffs are later attached to Plans.
Account access
Reseller: Yes
Enterprise: No
POST Tariff – Create
Endpoint
POST /api/createTariffHeaders
Content-Type: application/json
X-Requested-With: XMLHttpRequest
X-Authorization: Bearer <AccessToken>Request body
Top-level object: tariffInfo
Field | Mandatory | Description |
|---|---|---|
tariffName | Yes | Tariff name |
ratezoneId | Yes | Ratezone id |
serviceProfileId | Yes | Service profile id |
status | Yes |
|
Result codes (selected)
Code | Description |
|---|---|
1501 | Create tariff success |
1502 | Create tariff failure |
1503 | Duplicate tariff name |
10239 | Operation failed (verify completion) |
10240 | Operation timeout (verify completion) |
GET Tariff
Endpoint
GET /api/GetTariffHeaders
Content-Type: application/json
X-Requested-With: XMLHttpRequest
X-Authorization: Bearer <AccessToken>Query parameters
Parameter | Mandatory | Description |
|---|---|---|
tariffId | No | Fetch a specific tariff |
Response (selected)
Returned under responseParam.rows[]:
Field | Description |
|---|---|
tariffId | Tariff id |
tariffName | Tariff name |
ratezoneId | Linked ratezone |
serviceProfileId | Linked service profile |
status | Tariff status |
Result codes (selected)
Code | Description |
|---|---|
1504 | Get tariff success |
1505 | Get tariff failure |
1359 | No data available |
POST Tariff – Modify
Endpoint
POST /api/modifyTariffHeaders
Content-Type: application/json
X-Requested-With: XMLHttpRequest
X-Authorization: Bearer <AccessToken>Request body
Top-level object: tariffInfo
Field | Mandatory | Description |
|---|---|---|
tariffId | Yes | Tariff id |
tariffName | No | Updated name |
ratezoneId | No | Updated ratezone |
serviceProfileId | No | Updated service profile |
status | No | Updated status |
Result codes (selected)
Code | Description |
|---|---|
1506 | Modify tariff success |
1507 | Modify tariff failure |
10239 | Operation failed (verify completion) |
10240 | Operation timeout (verify completion) |
POST Tariff – Delete
Endpoint
POST /api/deleteTariffHeaders
Content-Type: application/json
X-Requested-With: XMLHttpRequest
X-Authorization: Bearer <AccessToken>Request body
Top-level object: tariffInfo
Field | Mandatory | Description |
|---|---|---|
tariffId | Yes | Tariff id |
Result codes (selected)
Code | Description | Next steps |
|---|---|---|
1508 | Delete tariff success | — |
1509 | Delete tariff failure | — |
1510 | Tariff attached to plan | Use GET Query Rate Plan |
Cross-API parameter sourcing
ratezoneId: via GET RatezoneserviceProfileId: via GET Service ProfiletariffId: via GET Tariff or Create responseDependency checks:
Plan usage: GET Query Rate Plan