Services

Create service

Creates new Internet service.

post/admin/customers/customer/{customer_id}/internet-services

Request

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

Path parameters

customer_idnumber double required
Example:1

The ID of the desired Customer.

Request body

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

Example request

{
  "customer_id": 1,
  "tariff_id": 1,
  "status": "active",
  "description": "Some Description",
  "quantity": 1,
  "start_date": "2016-01-01",
  "end_date": "0000-00-00",
  "discount_type": "percent",
  "status_new": "stopped",
  "top_up_tariff_id": 1,
  "parent_id": 1,
  "on_approve": "0",
  "period": "-1"
}

Response

idnumber required

Internet service Id

Example response

{
  "id": 1
}

Changes

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