Tariffs

Retrieve Bundle tariff

Work with Bundle tariff.Retrieves Bundle tariff with the given ID.

get/admin/tariffs/bundle/{id}

Request

  • Base URL: https://demo.splynx.com/api/2.0
  • URL: https://demo.splynx.com/api/2.0/admin/tariffs/bundle/{id}
  • Auth: HTTP basic

Path parameters

idnumber double required
Example:1

The ID of the desired Bundle tariff.

Response

titlestring required

Unique title of tariff

service_descriptionstring

Unique service description

partners_idsstring[] required

List of partners (ids) who can use this tariff

pricenumber

Price. Default: 0

with_vatboolean

With VAT or not. Default: 1

vat_percentnumber

VAT value. Default: 21

activation_feenumber

Activation fee. Default: 0

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

change_to_other_bundle_feenumber

Change to other bundle fee. Default: 0

contract_durationnumber

Contract duration

get_activation_fee_whenstring

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

automatic_renewalboolean

Automatic renewal. Default: 0

auto_reactivateboolean

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

discount_periodnumber

Discount period

discount_typestring

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

discount_valuenumber

Discount value

internet_tariffsstring[]

Internet tariffs plans

voice_tariffsstring[]

Voice tariffs plans

custom_tariffsstring[]

Custom tariffs plans

billing_typesstring[]

Types of billing

billing_days_countnumber

Prepaid period days. Default: 1

custom_period0 | 1

Use for check if use custom period

available_for_servicesboolean

Available to assign in services

idnumber required

Bundle tariff ID

Example response

{
  "title": "Aplha",
  "service_description": "aplha",
  "partners_ids": [
    "1",
    "2"
  ],
  "price": 100,
  "with_vat": true,
  "vat_percent": 19,
  "activation_fee": 0.5,
  "issue_invoice_while_service_creation": true,
  "cancellation_fee": 1.5,
  "prior_cancellation_fee": 1.5,
  "change_to_other_bundle_fee": 0,
  "contract_duration": 1,
  "get_activation_fee_when": "create_service",
  "automatic_renewal": true,
  "auto_reactivate": false,
  "discount_period": 5,
  "discount_type": "percent",
  "discount_value": 15,
  "internet_tariffs": [
    "1",
    "2"
  ],
  "voice_tariffs": [
    "1",
    "2",
    "3"
  ],
  "custom_tariffs": [
    "1",
    "2",
    "3"
  ],
  "billing_types": [
    "recurring",
    "prepaid",
    "prepaid_monthly"
  ],
  "billing_days_count": 1,
  "custom_period": 1,
  "available_for_services": true,
  "customer_labels": [
    {
      "id": 1,
      "label": "Label name",
      "color": "#357bf2"
    }
  ],
  "id": 1,
  "tariff_labels": [
    {
      "id": 1,
      "label": "Label name",
      "color": "#357bf2"
    }
  ]
}

Changes

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