CAP

Add a Capped data

Adds a new Capped data record.

post/admin/fup/capped-data

Request

  • Base URL: https://demo.splynx.com/api/2.0
  • URL: https://demo.splynx.com/api/2.0/admin/fup/capped-data
  • Auth: HTTP basic

Request body

service_idnumber required

Existing service Id.

quantitynumber

Traffic amount. Required if not set tariff_id. Default: 0

quantity_remindnumber

Remind traffic amount. Default: 0

tariff_idnumber

Existing CAP Tariff Id. If set then price and quantity will be taken from tariff. Required if not set price.

over_usagenumber

Represents the amount of traffic that exceeds the FUP limit. If the usage surpasses the FUP limit, over_usage is calculated as usage - fup limit.

valid_tillstring

Valid till date.

end_of_periodstring

End of period.

pricenumber

Price of the Capped data. Required if not set tariff_id. Default: 0

Example request

{
  "service_id": 1,
  "quantity": 10000000,
  "quantity_remind": 10000000,
  "tariff_id": 1,
  "over_usage": 1,
  "valid_till": "0000-00-00 00:00:00",
  "end_of_period": "0000-00-00 00:00:00"
}

Response

idnumber required

Capped data Id.

Example response

{
  "id": 1
}

Changes

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