Services

List internet services by parameters

Get list internet services by parameters.Returns list internet services by parameters.

get/admin/customers/customer/0/internet-services

Request

  • Base URL: https://demo.splynx.com/api/2.0
  • URL: https://demo.splynx.com/api/2.0/admin/customers/customer/0/internet-services
  • Auth: HTTP basic

Query parameters

paramsstring required
Example:http_build_query($search)

Any parameters of service. <br>You should set at least one service`s parameter. <br>This parameters should be converted to query string.<br>For example:<br>$search = [ <br>  'main_attributes' => [<br>    'tariff_id' => '1'<br>   ]<br>]<br>;<br>

Response

customer_idnumber required

Customer ID

tariff_idnumber required

Tariff ID

statusstring required

Status. Values: 'active', 'stopped', 'disabled', 'hidden', 'pending'

descriptionstring required

Description

quantitynumber required

Quantity

unitnumber

Unit

unit_pricenumber

Unit price

start_datestring required

Start date. Format: YYYY-MM-DD

end_datestring required

End date. Format: YYYY-MM-DD. Set to '0000-00-00' for endless

discountstring

Discount

discount_typestring

Type of discount: 'percent' or 'fixed'. Default value: 'percent'

discount_valuenumber

Discount value

discount_start_datestring

Discount start date

discount_end_datestring

Discount end date

discount_textstring

Discount message

router_idnumber

Router ID

sector_idnumber

Router sector ID. If you set router you can set its sector

loginstring required

Service login. Recommended to use customer login as prefix

passwordstring

Service password

taking_ipv4number required

Taking IPv4. Values: '0' - None (Router will assign IP), '1' - Permanent IP (from Static IPs), '2' - Dynamic IP (from IP Pools)

ipv4string

If taking_ipv4 set to 1 you can set IPv4

ipv4_routestring

If taking_ipv4 set to 1 you can set additional network

ipv4_pool_idnumber

If 'taking_ipv4' set to 2 you can set pool id.

ipv6string

IPv6 network

ipv6_delegatedstring

IPv6 delegated network

ipv6_pool_idnumber

IPv6 Pool ID

taking_ipv6number

Taking IPv6. Values: '0' - None (Router will assign IP), '1' - Permanent IP (from Static IPs), '2' - Dynamic IP (from IP Pools)

macstring

Mac(s,)

port_idnumber

Port ID

access_devicenumber

ID of access device hardware (Monitoring device). Default: 0

bundle_service_idnumber

ID of bundle service. 0 for none

status_newstring

Indicates the status of the parent service. Default: ''

top_up_tariff_idnumber

Cap tariff id. Default: 0

parent_idnumber

ID of Parent service. 0 for none

on_approvestring

Indicates whether the service needs to be approved. Values: '0', '1'. Default: 0

periodstring

Period of which to charge for this service: 0 for postpaid and number of period (from 1 to 99). Default: -1

idnumber required

Internet service Id

typestring

Service type

speed_downloadinteger nullable

Download speed (kbps) taken from the tariff the service is based on. null if the tariff no longer exists.

speed_uploadinteger nullable

Upload speed (kbps) taken from the tariff the service is based on. null if the tariff no longer exists.

Example response

[
  {
    "customer_id": 1,
    "tariff_id": 1,
    "status": "active",
    "description": "Some Description",
    "quantity": 1,
    "unit": 0,
    "unit_price": 0,
    "start_date": "2016-01-01",
    "end_date": "0000-00-00",
    "discount": "",
    "discount_type": "percent",
    "discount_value": 0,
    "discount_start_date": "",
    "discount_end_date": "",
    "discount_text": "",
    "router_id": 0,
    "sector_id": 0,
    "login": "",
    "password": "",
    "taking_ipv4": 0,
    "ipv4": "",
    "ipv4_route": "",
    "ipv4_pool_id": 0,
    "ipv6": "",
    "ipv6_delegated": "",
    "ipv6_pool_id": 0,
    "taking_ipv6": 0,
    "mac": "",
    "port_id": 0,
    "access_device": 0,
    "bundle_service_id": 0,
    "status_new": "stopped",
    "top_up_tariff_id": 1,
    "parent_id": 1,
    "on_approve": "0",
    "period": "-1",
    "id": 1,
    "geo": {
      "address": "",
      "marker": "",
      "src": "customer"
    },
    "type": "internet",
    "speed_download": 100000,
    "speed_upload": 50000,
    "replaced_by": {
      "service_name": "Fiber 200 Mbps",
      "date": "2026-08-01"
    }
  }
]

Changes

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