API: List cancellations

getCancellations

Get list of cancellation requests

TIP

This API call uses pagination for results.

Optional parameters

Parameter	Description
page	Which page to return
filter[client_id]	Filter by client id
filter[date]	Filter by date
filter[type]	Filter by type
filter[item_type]	One of Account,Domain
filter[item_id]	Related account or domain id

Request

GET /admin/api.php?api_id=API_ID&api_key=API_KEY&call=getCancellations

PHP Samples

Response

{
    "success": true,
    "logs": [
        {
            "id": "52",
            "date": "2023-05-09 22:22:00",
            "reason": "test",
            "type": "End of billing period",
            "item_id": "1310",
            "item_type": "Account",
            "process_at": "0000-00-00 00:00:00",
            "processed_at": "2023-05-09 22:27:58",
            "who": "Client",
            "next_invoice": "2024-04-17",
            "domain": "",
            "status": "Terminated",
            "next_due": "2024-04-24",
            "name": "Package B2",
            "category": "Power Hosting",
            "firstname": "Grayson",
            "lastname": "Heller",
            "client_id": "432"
        }
    ],
    "call": "getCancellations",
    "sorter": {
        "perpage": 25,
        "totalpages": 1,
        "sorterrecords": 1,
        "sorterpage": 1
    },
    "server_time": 1684236552
}