Residential subpackages (subusers)
Updated:
A subpackage is a slice of your residential pool for another person or project: its own key, traffic allowance, expiry and lists. Creating one reserves traffic you already own — it buys nothing.
Permissions: account:read, account:write
In this group
Tool | What it does | |
|---|---|---|
🟢 | All subpackages with | |
🟡 | Create a subpackage out of traffic you already own. | |
🟡 | Change traffic, expiry, rotation or pause/resume. | |
🔴 | Delete a subpackage and its lists. | |
🟢 | All lists inside one subpackage. | |
🟡 | Same as add_resident_list, plus | |
🟡 | Rename one list inside a subpackage. | |
🟡 | Change the rotation of one list inside a subpackage. | |
🔴 | Delete one list inside a subpackage. | |
🟡 | API Tools list inside a subpackage. |
list_resident_subpackages
🟢 read-only · account:read
All subpackages with package_key, allocated/used/remaining traffic (bytes), rotation, expiry, state.
create_resident_subpackage
🟡 changes account state · account:write
Create a subpackage out of traffic you already own.
Parameter | Type | Description |
|---|---|---|
| integer | Bytes (1 GB = 1073741824), taken from your pool |
| string |
|
| boolean | Follow the parent package expiry |
| integer | Default rotation for its lists |
update_resident_subpackage
🟡 changes account state · account:write
Change traffic, expiry, rotation or pause/resume. Send at least one field.
Parameter | Type | Description |
|---|---|---|
| string | Subpackage key |
| integer | Bytes |
| string |
|
| boolean | Follow the parent expiry |
| integer | Default rotation |
| boolean |
|
delete_resident_subpackage
🔴 destructive · account:write
Delete a subpackage and its lists. Unused traffic returns to your pool.
Parameter | Type | Description |
|---|---|---|
| string | Subpackage key |
list_resident_subuser_lists
🟢 read-only · account:read
All lists inside one subpackage. password comes back masked unless you ask for it.
Parameter | Type | Description |
|---|---|---|
| string | Subpackage key |
| boolean | Return |
add_resident_subuser_list
🟡 changes account state · account:write
Same as add_resident_list, plus package_key. country is required here.
rename_resident_subuser_list
🟡 changes account state · account:write
Rename one list inside a subpackage.
Parameter | Type | Description |
|---|---|---|
| string | Subpackage key |
| string | integer | List id |
| string | New name |
set_resident_subuser_rotation
🟡 changes account state · account:write
Change the rotation of one list inside a subpackage.
Parameter | Type | Description |
|---|---|---|
| string | Subpackage key |
| string | integer | List id |
| integer |
|
delete_resident_subuser_list
🔴 destructive · account:write
Delete one list inside a subpackage.
Parameter | Type | Description |
|---|---|---|
| string | Subpackage key |
| string | integer | List id |
create_resident_subuser_tools_list
🟡 changes account state · account:write
API Tools list inside a subpackage.
Parameter | Type | Description |
|---|---|---|
| string | Subpackage key |