Tariffs

Call tariffs control how the platform prices calls, data, and events from usage files. See Call Tariffs for full details on how tariffs work.

Methods

GET

Retrieve Single Tariff

/backend/api/v1/tariffs/ID - fetch tariff with specified ID.

List Tariffs

/backend/api/v1/tariffs/ - list all tariffs.

POST

/backend/api/v1/tariffs/ - create a new tariff. The newly-created tariff will be returned.

PATCH

/backend/api/v1/tariffs/ID - update tariff with specified ID. The modified tariff will be returned.

DELETE

/backend/api/v1/tariffs/ID - delete tariff with specified ID.

Note: A 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/tariffs/ID/actionName.

applyIncrease

Applies a percentage price increase to the tariff in-place. Requires expert level 5 access.

Parameters:

Example:

curl -X POST \
  https://YOUR-DOMAIN/backend/api/v1/tariffs/123/applyIncrease \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "increasePercent": 3.5,
    "increaseScope": "costOnly"
  }'

Returns the updated tariff.

createIncreaseVersion

Creates a new tariff with prices increased by the specified percentage. The original tariff is not modified.

Parameters:

Example:

curl -X POST \
  https://YOUR-DOMAIN/backend/api/v1/tariffs/123/createIncreaseVersion \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "increasePercent": 3.5,
    "increaseScope": "costOnly"
  }'

Returns the new 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