Tariffs

Create Internet tariff

Creates new Internet tariff.

post/admin/tariffs/internet

Request

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

Request body

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)

customer_labelsnumber[]

Array of customer labels (ids)

tariff_labelsnumber[]

Array of tariff labels (ids)

Example request

{
  "title": "Aplha",
  "service_name": "aplha",
  "price": 100,
  "with_vat": true,
  "vat_percent": 19,
  "speed_download": 102400,
  "speed_upload": 102400,
  "speed_limit_at": 10,
  "aggregation": 1,
  "speed_limit_type": "none",
  "billing_days_count": 1,
  "custom_period": 1,
  "available_for_services": true
}

Response

idnumber required

Internet tariff ID

Example response

{
  "id": 1
}

Changes

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