Customers

Retrieve a Customer cap

Work with Customer cap.Retrieves the Customer cap with the given ID.

get/admin/customers/customer-cap/{id}

Request

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

Path parameters

idnumber double required

Example:1

The ID of the desired Customer.

Response

customer_idnumber

Customer ID

auto_capstring

Auto cap. Default value: '0'

limitation_typestring

Limitation type: "auto_top_up", "manual_top_up", "any_top_up". Default value: "auto_top_up"

max_cap_during_monthnumber

Max cap during per month. Default value: '0'

transfer_usage_to_new_servicestring

Transfer usage to new service. Default value: '1'

deletedstring

Deleted record. Default value: '0'

Example response

{
  "customer_id": 1,
  "auto_cap": "0",
  "limitation_type": "auto_top_up",
  "max_cap_during_month": 10,
  "transfer_usage_to_new_service": "1",
  "deleted": "0"
}

Changes

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