CAP

Retrieve a Cap Tariff

Work with Cap Tariff record.Retrieves the Cap Tariff record with the given ID.

get/admin/fup/cap-tariff/{id}

Request

Base URL: https://demo.splynx.com/api/2.0
URL: https://demo.splynx.com/api/2.0/admin/fup/cap-tariff/{id}
Auth: HTTP basic

Path parameters

idnumber double required

Example:1

The ID of the desired Cap Tariff record.

Response

tariff_idnumber

Tariff ID

titlestring required

Title

amountnumber required

Amount

amount_instring

Amount in: 'gb' or 'mb'. Default: 'mb'

pricenumber

Price

typestring

Type: 'manual', 'automatic'. Default: 'manual'

validity'end_of_period' | 'unlimited' | 'number_of_months' | 'number_of_days' | 'number_of_hours' required

Validity

validity_numbernumber

Validity number is required if validity set to one of values: 'number_of_months', 'number_of_days', 'number_of_hours'. For 'number_of_months' values 1-12; for 'number_of_days' values 1-365; for 'number_of_hours' values 1-72.

to_invoicenumber

To invoice: '0', '1'. Default '0'

transaction_category_idnumber

Transaction category. Default '0'

idnumber required

Cap Tariff ID

Example response

{
  "tariff_id": 1,
  "title": "lte-top-1g",
  "amount": 1,
  "amount_in": "gb",
  "price": 100,
  "type": "manual",
  "validity": "number_of_hours",
  "validity_number": 5,
  "to_invoice": 1,
  "transaction_category_id": 1,
  "id": 1
}

Changes

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