Tariff Plans
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.
Below is a sample tariff plan in JSON representation.
{
"id": 1,
"name": "Evaluation Plan",
"description": "Plan for first-time customers, including 3 SIMs per month",
"status": {
"id": 2,
"description": "Deprecated"
},
"deprecation_date": "2016-01-20 00:00:00",
"min_runtime": {
"id": 12,
"number_of_units": 12,
"unit":{
"id": 1,
"name": "month"
}
},
"payment":[
{
"id": 2,
"interval": {
"id": 1,
"name": "month"
},
"amount": 29.99,
"currency": {
"id":1,
"code": "EUR",
"symbol": "€"
}
},
{
"id": 5,
"interval": {
"id": 2,
"name": "contract term"
},
"amount": 450.00,
"currency": {
"id":1,
"code": "EUR",
"symbol": "€"
}
}
]
}
Tariff Plan Object
Here is the description of the tariff plan object:
Name | Type | Description |
---|---|---|
id | Integer | Unique ID of this tariff plan |
name | String | short name of this tariff plan |
description | String | long description of this tariff plan |
status | Object | the status of this tariff plan |
owner_organisation | Object | the organisation that owns the tariff plan |
deprecation_date | Date | Date when the tariff plan became deprecated |
min_runtime | Object | minimum running duration for this tariff plan |
payment | Object | list of available payment schemes for this tariff plan |