Add-ons package-upgrades
Quotas or features bought per unit on top of a base package.
Pick an endpoint to see its example call on the right.
Authentication
Send the X-API-Key header (create a key on the API Keys page; the key is shown only once at creation). An Authorization: Bearer token obtained by logging in also works.
X-API-Key
Authentication failures return 401; forbidden returns 403 (code such as insufficient_scope).
Conventions
Paging uses page (from 1) and page_size; sort with sort=field or sort=-field.
Times are RFC 3339 (UTC); amounts are in cents.
Writes return 200/201/204 on success; duplicates of a unique key return 409.
/api/v2/package-upgradesList add-ons
Authentication: Admin only
Query parameters
| Field | Type | Description |
|---|---|---|
page | integer | Page number, starting from 1 |
page_size | integer | Items per page |
sort | string | Sort fields, comma-separated; prefix `-` for descending, e.g. `-created_at,id` |
/api/v2/package-upgradesCreate add-on
Authentication: Admin only
Request body application/json
| Field | Type | Description |
|---|---|---|
amount | integer | Amount added per unit; always 1 for feature items (custom_cc_rule/websocket). |
bind_packages | integer[] | Only these base packages may buy it; empty = no restriction. |
des | string | Description |
enabled | boolean | Whether enabled |
nameRequired | string | Name |
price_centsRequired | integer | Price per unit per month, in cents. |
prices | UpgradePrice[] | Per-currency prices; must include the base-currency row (mode=base, its price = price_cents). mode=manual uses the fixed price, mode=auto is derived from the base price at the current rate. Omit prices on write to leave non-base rows untouched. The package catalog (/package-catalog) uses the purchase view: missing currencies are filled in as auto rows priced at the current rate, and currencies whose rate is not ready are left out; the admin endpoints return only the stored rows. |
typeRequired | string | Add-on item: traffic GB, domains, non-standard ports, TCP/UDP forwarding ports, custom CC, bandwidth Mbps, connections, WebSocket, dedicated IPs. |
/api/v2/package-upgrades/{id}Get add-on
Authentication: Admin only
/api/v2/package-upgrades/{id}Update add-on
Authentication: Admin only
Request body application/json
| Field | Type | Description |
|---|---|---|
amount | integer | Amount added per unit; always 1 for feature items (custom_cc_rule/websocket). |
bind_packages | integer[] | Only these base packages may buy it; empty = no restriction. |
des | string | Description |
enabled | boolean | Whether enabled |
nameRequired | string | Name |
price_centsRequired | integer | Price per unit per month, in cents. |
prices | UpgradePrice[] | Per-currency prices; must include the base-currency row (mode=base, its price = price_cents). mode=manual uses the fixed price, mode=auto is derived from the base price at the current rate. Omit prices on write to leave non-base rows untouched. The package catalog (/package-catalog) uses the purchase view: missing currencies are filled in as auto rows priced at the current rate, and currencies whose rate is not ready are left out; the admin endpoints return only the stored rows. |
typeRequired | string | Add-on item: traffic GB, domains, non-standard ports, TCP/UDP forwarding ports, custom CC, bandwidth Mbps, connections, WebSocket, dedicated IPs. |
/api/v2/package-upgrades/{id}Delete add-on
Authentication: Admin only
Add-ons object
| Field | Type | Description |
|---|---|---|
active_count | integer | Units in use, summed over unexpired user packages. Returned by the admin list only. |
amount | integer | Amount added per unit; always 1 for feature items (custom_cc_rule/websocket). |
bind_packages | integer[] | Only these base packages may buy it; empty = no restriction. |
created_at | string | Created at |
des | string | Description |
enabled | boolean | Whether enabled |
id | integer | Record ID |
name | string | Name |
price_cents | integer | Price per unit per month, in cents. |
prices | UpgradePrice[] | Per-currency prices; must include the base-currency row (mode=base, its price = price_cents). mode=manual uses the fixed price, mode=auto is derived from the base price at the current rate. Omit prices on write to leave non-base rows untouched. The package catalog (/package-catalog) uses the purchase view: missing currencies are filled in as auto rows priced at the current rate, and currencies whose rate is not ready are left out; the admin endpoints return only the stored rows. |
recent_30d | integer | Units bought in the last 30 days, summed over add-on orders (free add-ons not counted). Returned by the admin list only. |
type | string | Add-on item: traffic GB, domains, non-standard ports, TCP/UDP forwarding ports, custom CC, bandwidth Mbps, connections, WebSocket, dedicated IPs. |
updated_at | string | Updated at |
user_package_count | integer | Number of user packages that have bought this add-on, expired ones included; above 0 it cannot be deleted, only disabled. Returned by the admin list only. |
Responses and errors
Success returns the resource JSON directly (HTTP 2xx); failures return application/problem+json (code, detail, plus errors on validation failures); lists carry items + total.
{
"id": 1,
"name": "example"
}{
"items": [
{
"id": 1
}
],
"page": 1,
"page_size": 20,
"total": 1
}{
"code": "validation_failed",
"detail": "Invalid request parameters",
"errors": [
{
"code": "required",
"field": "/name",
"message": "name is required"
}
],
"request_id": "0123456789abcdef",
"status": 422,
"title": "Unprocessable Entity",
"type": "about:blank"
}