Tariffs

Retrieve tariffs for change

Change tariff for service.Retrieves suitable tariffs list for change from source tariff.

get/admin/tariffs/tariffs-for-change

Request

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

Query parameters

service_idnumber double
Example:1

Optional. The ID of the service being changed. When provided, each returned tariff additionally includes minimal_start_date, fee and fee_raw.

sub_idnumber double
Example:1

Optional. Available for the main LBA (Linked Billing Account) customer. When provided, returns tariffs available for the sub-account; the sub-account must belong to the main customer taken from the token.

service_type'internet' | 'voice' | 'custom' required

Service type.

type'internet' | 'voice' | 'custom' required

Tariff type

tariff_idnumber double required
Example:2

The ID of source tariff

idstring required
Example:{tariff_id}

Response

idnumber

Tariff ID

titlestring

Tariff title

pricestring

Tariff price

minimal_start_datestring

Minimal allowed start date for the service change. Present only when "service_id" is passed.

feestring

Localized fee charged when changing to this tariff. Present only when "service_id" is passed.

fee_rawnumber

Raw fee value charged when changing to this tariff. Present only when "service_id" is passed.

vat_percentstring

VAT percent

with_vatboolean

Price with VAT

other_propertiesstring

And other properties according to tariff type

hide_on_admin_portalboolean required

Hide tariff on Admin portal. Default: false

show_on_customer_portalboolean

Show tariff on Customer portal. Default: false

available_for_locationsnumber[]

Array of locations (ids)

customer_categoriesstring[]

Customer categories

partners_idsstring[] required

Array of partners (ids) who can use this tariff

tax_idnumber

Tax id

service_namestring

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

billing_days_countnumber

Prepaid period days. Default: 1

available_for_servicesboolean

Available to assign in services

billing_typesstring[]

Types of billing

tariffs_for_changenumber[]

Tariff plans available in customer portal for changing services (ids)

speed_downloadnumber required

Download speed (kbps)

speed_uploadnumber required

Upload speed (kbps)

speed_limit_typestring

Type. Can be none, percent, fixed

speed_limit_atnumber

Guaranteed speed limit at X%. Default: 10

speed_limit_fixed_upnumber

Guaranteed upload speed limit. Default: 0

speed_limit_fixed_downnumber

Guaranteed download speed limit. Default: 0

aggregationnumber

Aggregation: 1:X. Default: 1

burst_typestring[]

Burst. Default: none

burst_limitnumber

Burst limit: +X%. Default: 0

burst_limit_fixed_upnumber

Upload burst limit. Default: 0

burst_limit_fixed_downnumber

Download burst limit. Default: 0

burst_thresholdnumber

Burst threshold: X%. Default: 0

burst_threshold_fixed_upnumber

Upload burst threshold. Default: 0

burst_threshold_fixed_downnumber

Download burst threshold. Default: 0

burst_timenumber

Burst time: X sec. Default: 0

prioritystring[]

Priority

exclude_traffic_classesnumber[]

IDs of Traffic classes

servicesnumber

Number of services used

Example response

[
  {
    "id": 3,
    "title": "Tariff title",
    "minimal_start_date": "2026-07-10",
    "fee": "10.00",
    "fee_raw": 10,
    "price": "10.30",
    "vat_percent": "21.0",
    "with_vat": true,
    "other_properties": "Other properties",
    "hide_on_admin_portal": false,
    "show_on_customer_portal": false,
    "available_for_locations": [
      1
    ],
    "customer_categories": [
      "person",
      "company"
    ],
    "partners_ids": [
      "1"
    ],
    "tax_id": 0,
    "service_name": "aplha",
    "billing_days_count": 1,
    "available_for_services": true,
    "billing_types": [
      "recurring",
      "prepaid",
      "prepaid_monthly"
    ],
    "tariffs_for_change": [
      0
    ],
    "speed_download": 102400,
    "speed_upload": 102400,
    "speed_limit_type": "none",
    "speed_limit_at": 10,
    "speed_limit_fixed_up": 0,
    "speed_limit_fixed_down": 0,
    "aggregation": 1,
    "burst_type": [
      "none",
      "percent",
      "fixed"
    ],
    "burst_limit": 0,
    "burst_limit_fixed_up": 0,
    "burst_limit_fixed_down": 0,
    "burst_threshold": 0,
    "burst_threshold_fixed_up": 0,
    "burst_threshold_fixed_down": 0,
    "burst_time": 0,
    "priority": [
      "low",
      "normal",
      "high"
    ],
    "exclude_traffic_classes": [
      0
    ],
    "services": 0
  }
]

Changes

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