Skip to main content

Tariffs

Tariffs define the data allowances and pricing attached to a pool or SIM. The API supports three tariff structures: Standard, Dynamic Pool, and Fixed Pool.

Base URL

https://app.zentarinetworks.com

List Tariffs

GET /api/tariffs

Returns all tariffs available to your tenant.

Response

Array of tariff objects — see Tariff Object below.


Get Tariff

GET /api/tariffs/{id}

Path Parameters

ParameterTypeDescription
idintegerTariff ID

Tariff Object

FieldTypeDescription
idintegerTariff ID
displayNamestringHuman-readable name
descriptionstringDescription
isActivebooleanWhether this tariff is available for new assignments
typeintegerTariff type code — see /api/tariffs/metadata
standardTariffobject?Present for Standard tariffs
dynamicPoolTariffobject?Present for Dynamic Pool tariffs
fixedPoolTariffobject?Present for Fixed Pool tariffs

Standard Tariff Fields

FieldTypeDescription
baseTariffBytesinteger (int64)Included data in bytes
baseTariffGbdoubleIncluded data in GB
simMonthlyFeedoubleMonthly fee per SIM
smsFeedoubleFee per SMS
voiceFeedoubleFee per minute of voice
overageFeePerGbdoubleFee per GB of overage

Dynamic Pool Tariff Fields

FieldTypeDescription
baseTariffBytesinteger (int64)Included data in bytes
baseTariffGbdoubleIncluded data in GB
simMonthlyFeedoubleMonthly fee per SIM
smsFeedoubleFee per SMS
voiceFeedoubleFee per minute of voice
overageFeePerGbdoubleFee per GB of overage

Fixed Pool Tariff Fields

FieldTypeDescription
fixedCapacityBytesinteger (int64)Fixed pool capacity in bytes
fixedCapacityGbdoubleFixed pool capacity in GB
simMonthlyFeedoubleMonthly fee per SIM
fixedBucketCostdoubleMonthly cost for the fixed capacity bucket
smsFeedoubleFee per SMS
voiceFeedoubleFee per minute of voice
overageFeePerGbdoubleFee per GB of overage

Tariff Metadata

GET /api/tariffs/metadata

Returns human-readable labels for tariff type integer codes.

Response

{
"type": [
{ "code": 0, "description": "Standard" },
{ "code": 1, "description": "Dynamic Pool" },
{ "code": 2, "description": "Fixed Pool" }
]
}