Tariffs

Retrieve start date of new tariff

Change tariff for service.Retrieves the nearest possible start date of new tariff.

get/admin/tariffs/change-tariff/{service_id}

Request

  • Base URL: https://demo.splynx.com/api/2.0
  • URL: https://demo.splynx.com/api/2.0/admin/tariffs/change-tariff/{service_id}
  • Auth: HTTP basic

Path parameters

service_idnumber double required
Example:1

The ID of the desired Service.

Query parameters

service_type'internet' | 'voice' | 'custom' required

Service type.

typestring required
Example:{service_type}
sub_idnumber double
Example:42

Optional. Direct sub-account ID a main (linked-billing) account acts on behalf of. Honored only when the access token belongs to the main account that owns this sub: the sub must belong to the authenticated main and the targeted service must belong to that sub. For any other customer token the request is rejected with a not-found error. Ignored for admin tokens (they target the service owner directly).

Response

target_datestring required

Start date of new tariff

transaction_category_idnumber
servicesnumber

Number of services used

Example response

{
  "target_date": "2019-02-07",
  "transaction_category_id": 0,
  "services": 0
}

Changes

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