GET /user/services/{service_id}/addons

Retrieve purchased addons 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 all addons of a specific service.

Example response

{
  "data": [
    {
      "id": 456,
      "addon": {
        "id": 123,
        "name": "Shared web hosting"
      },
      "service": {
        "id": 123
      },
      "status": "Active",
      "registration_date": "2022-01-05",
      "billing": {
        "cycle": "monthly",
        "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"
            }
          }
        },
        "payment_gateway": {
          "name": "banktransfer",
          "description": "Bank Transfer",
          "supports_headless_payment_session": true
        },
        "next_due_date": "2022-05-01"
      },
      "renewal": {
        "id": 789,
        "type": "addon",
        "non_renewable_reason": "This service addon is not renewable because it has been cancelled.",
        "renewal_period": {
          "start": "2023-03-14",
          "end": "2024-04-14"
        },
        "price": {
          "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.