Tariffs

Retrieve Recurring tariff

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

get/admin/tariffs/recurring/{id}

Request

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

Path parameters

idnumber double required
Example:1

The ID of the desired Recurring tariff.

Response

titlestring required

Unique title of tariff

service_namestring

Unique service name. If not set will be get from title

partners_idsstring[] required

Array of partners (ids) who can use this tariff

pricenumber

Price

with_vatboolean required

With VAT or not

vat_percentnumber

VAT value

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

available_for_locationsnumber[]

Array of locations (ids)

customer_categoriesstring[]

Customer categories

hide_on_admin_portalboolean required

Hide tariff on Admin portal. Default: false

show_on_customer_portalboolean

Show tariff on Customer portal. Default: false

tax_idnumber

Tax id

idnumber required

Recurring tariff ID

servicesnumber

Number of services used

tariffs_for_changenumber[]

Tariff plans available in customer portal for changing services (ids)

transaction_category_idnumber

Example response

{
  "title": "Aplha",
  "service_name": "aplha",
  "partners_ids": [
    "1"
  ],
  "price": 100,
  "with_vat": true,
  "vat_percent": 19,
  "billing_types": [
    "recurring",
    "prepaid",
    "prepaid_monthly"
  ],
  "billing_days_count": 1,
  "custom_period": 1,
  "available_for_services": true,
  "available_for_locations": [
    1
  ],
  "customer_categories": [
    "person",
    "company"
  ],
  "customer_labels": [
    {
      "id": 1,
      "label": "Label name",
      "color": "#357bf2"
    }
  ],
  "hide_on_admin_portal": false,
  "show_on_customer_portal": false,
  "tax_id": 0,
  "id": 1,
  "services": 0,
  "tariffs_for_change": [
    0
  ],
  "transaction_category_id": 0,
  "tariff_labels": [
    {
      "id": 1,
      "label": "Label name",
      "color": "#357bf2"
    }
  ]
}

Changes

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