Services

Recurring services collection_Create service

Creates new Recurring service.

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

Request

Base URL: https://demo.splynx.com/api/2.0
URL: https://demo.splynx.com/api/2.0/admin/customers/customer/{customer_id}/recurring-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

status_newstring

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

bundle_service_idnumber

ID of bundle service. 0 for none

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",
  "parent_id": 1,
  "on_approve": "0",
  "period": "-1"
}

Response

idnumber required

Recurring service Id

Example response

{
  "id": 1
}

Changes

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