WHwhmcs

GET /user/services/{service_id}/configoptions

Retrieve selected configurable options for a specific service.

Request

  • Base URL
    https://developers.whmcs.com/api/v2
  • Auth
    none declared

Path parameters

service_idinteger required
Example:789

Service ID

Query parameters

pageinteger
Example:1

Page number

page_sizeinteger
Example:10

Number of items per page. The maximum allowed value is 500. The default value is 50.

Response

A list of selected configurable options of a specific service.

Example response

{
  "data": [
    {
      "id": 456,
      "config_option": {
        "id": 12,
        "name": "Config Option Name",
        "type": "dropdown"
      },
      "service": {
        "id": 123
      },
      "option": {
        "name": "Config Option Name",
        "value": true
      },
      "billing": {
        "price": {
          "first_payment": {
            "amount": {
              "value": "19.99",
              "code": "USD",
              "display_value": "$19.99 USD",
              "prefix": "$",
              "suffix": " USD"
            }
          },
          "recurring": {
            "amount": {
              "value": "19.99",
              "code": "USD",
              "display_value": "$19.99 USD",
              "prefix": "$",
              "suffix": " USD"
            }
          }
        }
      }
    }
  ]
}

Changes

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