FUP

Retrieve FUP Limit

Work with FUP Limit.Retrieves FUP Limit with the given Tariff ID

get/admin/fup/fup-limits/{tariff_id}

Request

  • Base URL: https://demo.splynx.com/api/2.0
  • URL: https://demo.splynx.com/api/2.0/admin/fup/fup-limits/{tariff_id}
  • Auth: HTTP basic

Path parameters

tariff_idnumber double required
Example:1

The Tariff ID of the desired FUP Limit

Response

tariff_idnumber required

Tariff id

cap_tariff_idnumber

CAP tariff id

traffic_fromstring

Traffic from. Default '00:00'

online_fromstring

Online from. Default '00:00'

traffic_tostring

Traffic to. Default '24:00'

online_tostring

Online to. Default '24:00'

traffic_daysstring[] required

Traffic days. Default '1,2,3,4,5,6,7'

online_daysstring[] required

Online days. Default '1,2,3,4,5,6,7'

actionstring

Action. Options('decrease', 'block'). Default 'block'

percentnumber

Percent

traffic_amountnumber

Traffic amount

traffic_directionstring

Options('up', 'down', 'up_down'). Default 'up_down'

traffic_instring

Traffic in. Options('kb', 'mb', 'gb', 'tb'). Default 'gb'

override_trafficboolean

Override traffic

online_amountnumber

Online amount

online_instring

Online in. Options('minutes', 'hours'). Default 'hours'

override_onlineboolean

Override online

rollover_databoolean

Rollover data

rollover_timeboolean

Rollover time

bonus_is_unlimitedboolean

Bonus is unlimited. Default 'true'

bonus_trafficnumber

Bonus traffic

bonus_traffic_instring

Bonus traffic in

fixed_upnumber

Upload in bytes

fixed_downnumber

Download in bytes

top_up_over_usageboolean

Compensate over usage via Top-Up

top_up_trigger_percentnumber

Auto Top-Up trigger value

use_bonus_when_normal_endedboolean

Allow the usage of bonus traffic when normal CAP is finished

Example response

{
  "tariff_id": 1,
  "cap_tariff_id": 1,
  "traffic_from": "00:00",
  "online_from": "00:00",
  "traffic_to": "24:00",
  "online_to": "24:00",
  "traffic_days": [
    "1",
    "2",
    "3"
  ],
  "online_days": [
    "1",
    "2",
    "3"
  ],
  "action": "block",
  "percent": 0,
  "traffic_amount": 12334,
  "traffic_direction": "up_down",
  "traffic_in": "gb",
  "override_traffic": false,
  "online_amount": 123,
  "online_in": "hours",
  "override_online": false,
  "rollover_data": false,
  "rollover_time": false,
  "bonus_is_unlimited": false,
  "bonus_traffic": 1
}

Changes

No recorded changes to this operation across all 1 revision of this API.