Reference

Tariff

The API provides services to retrieve the collection of tariffs or a single tariff, as well as CRUD operations via POST, GET, PATCH and DELETE actions.

The API entrypoints for tariffs can’t be used by ‘Enterprise’ organizations. Rates can only be positive decimal numbers (negative values aren’t allowed)

The following is a sample tariff in JSON representation:

1{
2  "id": 3,
3  "name": "Tariff for M2M Europe",
4  "description": "M2M Europe: Data+SMS",
5  "created": "2015-01-10 09:36:58",
6  "default_sms_mt_rate": 0.5,
7  "default_sms_mo_rate": 0.4,
8  "sim_issued_rate": 0.1,
9  "sim_activated_rate": 0.2,
10  "sim_suspended_rate": 0.3,
11  "sim_activation_rate": 0.6,
12  "sim_reactivation_rate": 0.8,
13  "sim_suspension_rate": 0.7,
14  "sim_termination_rate": 0.5,
15  "used_count": 2,
16  "assigned_count": 1,
17  "status": {
18    "description": "Active",
19    "id": 1
20  },
21  "currency": {
22    "id": 1,
23    "code": "EUR",
24    "symbol": "€"
25  },
26  "data_blocksize": {
27    "id": 10,
28    "octets": 1,
29    "description": "exact"
30  },
31  "data_throttle": {
32    "id": 9,
33    "octets": 256000,
34    "description": "256 kbit/s"
35  },
36  "pdp_context_definition": [
37    {
38      "id": 32,
39      "apn": "internet.test.org",
40      "default": true
41    }
42  ]
43}

Tariff object

NameTypeDescription
idIntegerUnique ID of this tariff
nameStringshort name of this tariff
descriptionStringlong description of this tariff
createdTimestampTimestamp when this tariff was created
- Type: ISO 8601 timestamp format
default_sms_mt_rateDoubledefault rate for SMS Mobile Terminated
default_sms_mo_rateDoubledefault rate for SMS Mobile Originated
sim_issued_rateDoublerate for issued SIM
sim_activated_rateDoublerate for activated SIM
sim_suspended_rateDoublerate for suspended SIM
sim_activation_rateDoubleSIM activation rate
sim_reactivation_rateDoubleSIM reactivation rate
sim_suspension_rateDoubleSIM suspension rate
sim_termination_rateDoubleSIM termination rate
used_countIntegercount of entries in tariff_profile table referencing this tariff
assigned_countIntegercount of entries in organisation_tariff_assignment table referencing this tariff
statusObjectid (Integer) - ID of status for this tariff
description (String) - Description for this status
currencyObjectid (Integer) - ID currency for this tariff
code (String) for this currency
symbol (String) for this currency
data_blocksizeObjectid (Integer) - ID data block size for this tariff
octets (Integer) for this data block size
description (String) for this data block size
data_throttleObjectid (Integer) - ID data throttle for this tariff
octets (Integer) for this data throttle
description (String) for this data throttle
pdp_context_definitionObjectlist of PDP context definitions assigned to this tariff