Services

List bundle services by parameters

Get list bundle services by parameters.Returns list bundle services by parameters.

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

Request

  • Base URL: https://demo.splynx.com/api/2.0
  • URL: https://demo.splynx.com/api/2.0/admin/customers/customer/0/bundle-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>    'bundle_id' => '1'<br>   ]<br>];<br>

Response

customer_idnumber required

Customer ID

bundle_idnumber required

Bundle plan ID

statusstring required

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

descriptionstring required

Description

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

automatic_renewalboolean

Automatic renewal. Default: false

activation_feenumber

Activation fee. Default: 0

auto_reactivateboolean

Auto reactivate when deposit become more then minimal balance. Default: 0

get_activation_fee_whenstring

Get activation fee when create service: 'create_service' or after first service billing day: 'first_service_billing'

issue_invoice_while_service_creationboolean

Issue an invoice while service creation. Default: 0

cancellation_feenumber

Cancellation fee. Default: 0

prior_cancellation_feenumber

Prior cancellation fee. Default: 0

activation_fee_transaction_idnumber

Activation fee transaction id. Default: 0

cancellation_fee_transaction_idnumber

Cancellation fee transaction id. Default: (null)

prior_cancellation_fee_transaction_idnumber

Prior cancellation fee transaction id. Default: 0

idnumber required

Recurring service Id

typestring

Service type

Example response

[
  {
    "customer_id": 1,
    "bundle_id": 1,
    "status": "active",
    "description": "Some Description",
    "unit_price": 0,
    "start_date": "2016-01-01",
    "end_date": "0000-00-00",
    "discount": "0",
    "discount_type": "percent",
    "discount_value": 0,
    "discount_start_date": "",
    "discount_end_date": "",
    "discount_text": "",
    "automatic_renewal": true,
    "activation_fee": 0.5,
    "auto_reactivate": false,
    "get_activation_fee_when": "create_service",
    "issue_invoice_while_service_creation": true,
    "cancellation_fee": 1.5,
    "prior_cancellation_fee": 1.5,
    "services_internet": [
      {
        "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"
      }
    ],
    "services_voice": [
      {
        "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": "",
        "voice_device_id": 0,
        "phone": "",
        "phonesArray": [],
        "bundle_service_id": 0,
        "direction": "outgoing",
        "status_new": "stopped",
        "parent_id": 1,
        "on_approve": "0",
        "period": "-1"
      }
    ],
    "services_custom": [
      {
        "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": "",
        "status_new": "stopped",
        "bundle_service_id": 0,
        "parent_id": 1,
        "on_approve": "0",
        "period": "-1"
      }
    ],
    "activation_fee_transaction_id": 137,
    "cancellation_fee_transaction_id": 137,
    "prior_cancellation_fee_transaction_id": 137,
    "id": 1,
    "type": "bundle"
  }
]

Changes

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