Packages

Manage all packages on your application

Get all packages

GET https://wemx.app/api/v1/packages

Returns all packages made on your application

200: OK

{
    "status": true,
    "current_page": 1,
    "data": [
        {
            "id": 22,
            "order": 0,
            "category_id": 3,
            "name": "Hestia Premium",
            "description": "",
            "icon": "hestia_premium.png",
            "service": "hestia",
            "status": "restricted",
            "global_quantity": -1,
            "client_quantity": -1,
            "require_domain": 0,
            "allow_coupons": 1,
            "allow_notes": 1,
            "data": {
                "package": "Premium"
            },
            "setup_on": "payment_received",
            "created_at": "2023-10-23T21:47:40.000000Z",
            "updated_at": "2023-10-25T21:09:29.000000Z"
        }
        // more results
    ],
    "first_page_url": "http://wemx.app/api/v1/packages?page=1",
    "from": 1,
    "last_page": 1,
    "last_page_url": "http://wemx.app/api/v1/packages?page=1",
    "links": [
        {
            "url": null,
            "label": "Previous",
            "active": false
        },
        {
            "url": "http://wemx.app/api/v1/packages?page=1",
            "label": "1",
            "active": true
        },
        {
            "url": null,
            "label": "Next",
            "active": false
        }
    ],
    "next_page_url": null,
    "path": "http://wemx.app/api/v1/packages",
    "per_page": 15,
    "prev_page_url": null,
    "to": 2,
    "total": 2
}

Available Relationships (optional)

https://wemx.app/api/v1/packages?include=category,prices

Available relationships:

category, prices, features, orders, emails, webhooks

Filters (optional)

https://wemx.app/api/v1/packages?filter[service]=pterodactyl

Available Filters:

id, category_id, name, description, service, status, global_quantity, client_quantity, require_domain, allow_notes, data, created_at

Tip: To filter JSON columns such as gateway, data and options, you can specify the key using ?filter[data->hestia_package]=1

Sorting (optional)

https://wemx.app/api/v1/packages?sort[created_at]=asc

Available Sorting Parameters:

id, name, service, status, global_quantity, client_quantity, require_domain, allow_notes, allow_coupons, created_at, order

Sorting operators

asc, desc, random

Dates (optional)

https://wemx.app/api/v1/packages?date=30days

Operator	Description
today	Get packages created today
yesterday	Get packages created yesterday
3days, 7days, 14days, 30days, 90days	Get packages created last x days
YYYY-MM-DD,YYY-MM-DD	Get packages created between a range of dates