Tariffs

Retrieve Internet tariff

Work with Internet tariff.Retrieves Internet tariff with the given ID.

get/admin/tariffs/internet/{id}

Request

  • Base URL: https://demo.splynx.com/api/2.0
  • URL: https://demo.splynx.com/api/2.0/admin/tariffs/internet/{id}
  • Auth: HTTP basic

Path parameters

idnumber double required
Example:1

The ID of the desired Internet tariff.

Response

titlestring required

Unique title of tariff

service_namestring

Unique service name. If not set will be get from title

partners_idsstring[] required

Array of partners (ids) who can use this tariff

pricenumber

Price

with_vatboolean required

With VAT or not

vat_percentnumber

VAT value

speed_downloadnumber required

Download speed (kbps)

speed_uploadnumber required

Upload speed (kbps)

speed_limit_atnumber

Guaranteed speed limit at X%. Default: 10

aggregationnumber

Aggregation: 1:X. Default: 1

burst_limitnumber

Burst limit: +X%. Default: 0

burst_limit_fixed_downnumber

Download burst limit. Default: 0

burst_limit_fixed_upnumber

Upload burst limit. Default: 0

burst_thresholdnumber

Burst threshold: X%. Default: 0

burst_threshold_fixed_downnumber

Download burst threshold. Default: 0

burst_threshold_fixed_upnumber

Upload burst threshold. Default: 0

burst_timenumber

Burst time: X sec. Default: 0

burst_typestring[]

Burst. Default: none

billing_typesstring[]

Types of billing

customer_categoriesstring[]

Customer categories

exclude_traffic_classesnumber[]

IDs of Traffic classes

hide_on_admin_portalboolean required

Hide tariff on Admin portal. Default: false

show_on_customer_portalboolean required

Show tariff on Customer portal. Default: false

prioritystring[]

Priority

speed_limit_typestring

Type. Can be none, percent, fixed

speed_limit_fixed_downnumber

Guaranteed download speed limit. Default: 0

speed_limit_fixed_upnumber

Guaranteed upload speed limit. Default: 0

tax_idnumber

Tax id

transaction_category_idnumber

Transaction category id. Default: 0

billing_days_countnumber

Prepaid period days. Default: 1

custom_period0 | 1

Use for check if use custom period

available_for_servicesboolean

Available to assign in services

available_for_locationsnumber[]

Array of locations (ids)

idnumber required

Internet tariff ID

servicesnumber

Number of services used

Example response

{
  "title": "Aplha",
  "service_name": "aplha",
  "partners_ids": [
    "1"
  ],
  "price": 100,
  "with_vat": true,
  "vat_percent": 19,
  "speed_download": 102400,
  "speed_upload": 102400,
  "speed_limit_at": 10,
  "aggregation": 1,
  "burst_limit": 0,
  "burst_limit_fixed_down": 0,
  "burst_limit_fixed_up": 0,
  "burst_threshold": 0,
  "burst_threshold_fixed_down": 0,
  "burst_threshold_fixed_up": 0,
  "burst_time": 0,
  "burst_type": [
    "none",
    "percent",
    "fixed"
  ],
  "billing_types": [
    "recurring",
    "prepaid",
    "prepaid_monthly"
  ],
  "customer_categories": [
    "person",
    "company"
  ],
  "exclude_traffic_classes": [
    0
  ],
  "hide_on_admin_portal": false,
  "show_on_customer_portal": false,
  "priority": [
    "low",
    "normal",
    "high"
  ],
  "speed_limit_type": "none",
  "speed_limit_fixed_down": 0,
  "speed_limit_fixed_up": 0,
  "tax_id": 0,
  "transaction_category_id": 0,
  "billing_days_count": 1,
  "custom_period": 1,
  "available_for_services": true,
  "available_for_locations": [
    1
  ],
  "customer_labels": [
    {
      "id": 1,
      "label": "Label name",
      "color": "#357bf2"
    }
  ],
  "id": 1,
  "services": 0,
  "tariff_labels": [
    {
      "id": 1,
      "label": "Label name",
      "color": "#357bf2"
    }
  ]
}

Changes

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