Reference

Tariff plan

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

The following is a sample tariff plan in JSON representation:

1{
2  "id": 1,
3  "name": "Evaluation Plan",
4  "description": "Plan for first-time customers, including 3 SIMs per month",
5  "status": {
6    "id": 2,
7    "description": "Deprecated"
8  },
9  "deprecation_date": "2016-01-20 00:00:00",
10  "min_runtime": {
11    "id": 12,
12    "number_of_units": 12,
13    "unit":{
14      "id": 1,
15      "name": "month"
16    }
17  },
18  "payment":[
19    {
20      "id": 2,
21      "interval": {
22        "id": 1,
23        "name": "month"
24      },
25      "amount": 29.99,
26      "currency": {
27        "id":1,
28        "code": "EUR",
29        "symbol": "€"
30      }
31    },
32    {
33      "id": 5,
34      "interval": {
35        "id": 2,
36        "name": "contract term"
37      },
38      "amount": 450.00,
39      "currency": {
40        "id":1,
41        "code": "EUR",
42        "symbol": "€"
43      }
44    }
45  ]
46}

Tariff plan object

Here is the description of the tariff plan object:

NameTypeDescription
idIntegerUnique ID of this tariff plan
nameStringshort name of this tariff plan
descriptionStringlong description of this tariff plan
statusObjectthe status of this tariff plan
owner_organisationObjectthe organization that owns the tariff plan
deprecation_dateDateDate when the tariff plan became deprecated
min_runtimeObjectminimum running duration for this tariff plan
paymentObjectlist of available payment schemes for this tariff plan