Plugin API
Plugin API
Home
GitHub
Welcome
Authentication
Error Handling
Official Plugins
Endpoints
Information
Command Queue
Listing
Packages
Community Goals
Payments
Checkout
Gift Cards
Coupons
Bans
Sales
Player Lookup
Powered by GitBook

Packages

get
Get all packages

https://plugin.tebex.io/packages
Get a list of all packages on your webstore.
Request
Response
Headers
X-Tebex-Secret
required
string
The secret key of a server.
Query Parameters
verbose
optional
boolean
Include descriptions of packages.
200: OK
[
    {
        "id": 12,
        "name": "My first package",
        "image": false,
        "price": 10,
        "expiry_length": 0,
        "expiry_period": "month",
        "type": "single",
        "category": {
            "id": 34,
            "name": "My Packages"
        },
        "global_limit": 0,
        "global_limit_period": "none",
        "user_limit": 0,
        "user_limit_period": "none",
        "servers": [
            {
                "id": 7,
                "name": "Test Server"
            }
        ],
        "required_packages": [],
        "require_any": false,
        "create_giftcard": false,
        "show_until": false,
        "gui_item": "",
        "disabled": false,
        "disable_quantity": false,
        "custom_price": false,
        "choose_server": false,
        "limit_expires": false,
        "inherit_commands": false,
        "variable_giftcard": false,
    },
    {
        "id": 125,
        "name": "$100 package",
        "image": "https://dunb17ur4ymx4.cloudfront.net/packages/images/45tdfgsdfg43tfgdfzzftt.png",
        "price": 100,
        "expiry_length": 0,
        "expiry_period": "month",
        "type": "single",
        "category": {
            "id": 684,
            "name": "Packages"
        },
        "global_limit": 0,
        "global_limit_period": "none",
        "user_limit": 0,
        "user_limit_period": "none",
        "servers": [
            {
                "id": 7,
                "name": "Test Server"
            }
        ],
        "required_packages": [],
        "require_any": false,
        "create_giftcard": false,
        "show_until": false,
        "gui_item": "",
        "disabled": false,
        "disable_quantity": false,
        "custom_price": false,
        "choose_server": true,
        "limit_expires": false,
        "inherit_commands": false,
        "variable_giftcard": false
    }
]

get
Retrieve a package

https://plugin.tebex.io/package/{package}
Retrieve a package from the webstore.
Request
Response
Path Parameters
package
required
string
The ID of a package.
Headers
X-Tebex-Secret
required
string
The secret key of a server.
200: OK
{
    "id": 12,
    "name": "My first package",
    "image": false,
    "price": 10,
    "expiry_length": 0,
    "expiry_period": "month",
    "type": "single",
    "category": {
        "id": 34,
        "name": "My Packages"
    },
    "global_limit": 0,
    "global_limit_period": "none",
    "user_limit": 0,
    "user_limit_period": "none",
    "servers": [
        {
            "id": 7,
            "name": "Test Server"
        }
    ],
    "required_packages": [],
    "require_any": false,
    "create_giftcard": false,
    "show_until": false,
    "gui_item": "",
    "disabled": false,
    "disable_quantity": false,
    "custom_price": false,
    "choose_server": false,
    "limit_expires": false,
    "inherit_commands": false,
    "variable_giftcard": false
}

put
Update a package

https://plugin.tebex.io/package/{package}
Update a package on your webstore.
Request
Response
Path Parameters
package
required
string
The ID of a package.
Headers
X-Tebex-Secret
required
string
The secret key of a server.
Body Parameters
disabled
optional
boolean
If the package is disabled.
name
optional
string
The name of the package.
price
optional
integer
The price of the package.
204: No Content
​
Endpoints - Previous
Listing
Next - Endpoints
Community Goals
Last updated 1 month ago
Contents
get
Get all packages
get
Retrieve a package
put
Update a package