Proxy-seller

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

list_resident_subpackages

🟢 read

All subpackages with package_key, allocated/used/remaining traffic (bytes), rotation, expiry, state.

create_resident_subpackage

🟡 write

Create a subpackage out of traffic you already own.

update_resident_subpackage

🟡 write

Change traffic, expiry, rotation or pause/resume.

delete_resident_subpackage

🔴 delete

Delete a subpackage and its lists.

list_resident_subuser_lists

🟢 read

All lists inside one subpackage.

add_resident_subuser_list

🟡 write

Same as add_resident_list, plus package_key.

rename_resident_subuser_list

🟡 write

Rename one list inside a subpackage.

set_resident_subuser_rotation

🟡 write

Change the rotation of one list inside a subpackage.

delete_resident_subuser_list

🔴 delete

Delete one list inside a subpackage.

create_resident_subuser_tools_list

🟡 write

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

traffic_limit required

integer

Bytes (1 GB = 1073741824), taken from your pool

expired_at

string

yyyy-MM-dd

is_link_date

boolean

Follow the parent package expiry

rotation

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

package_key required

string

Subpackage key

traffic_limit

integer

Bytes

expired_at

string

yyyy-MM-dd

is_link_date

boolean

Follow the parent expiry

rotation

integer

Default rotation

is_active

boolean

false pauses access without deleting anything

delete_resident_subpackage

🔴 destructive · account:write

Delete a subpackage and its lists. Unused traffic returns to your pool.

Parameter

Type

Description

package_key required

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

package_key required

string

Subpackage key

reveal

boolean

Return password in clear instead of ••••. The assistant confirms with you first — see Proxy passwords and the AI provider

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

package_key required

string

Subpackage key

id required

string | integer

List id

title required

string

New name

set_resident_subuser_rotation

🟡 changes account state · account:write

Change the rotation of one list inside a subpackage.

Parameter

Type

Description

package_key required

string

Subpackage key

id required

string | integer

List id

rotation required

integer

-1, 0, 1–3600, or -2 to use the subpackage default

delete_resident_subuser_list

🔴 destructive · account:write

Delete one list inside a subpackage.

Parameter

Type

Description

package_key required

string

Subpackage key

id required

string | integer

List id

create_resident_subuser_tools_list

🟡 changes account state · account:write

API Tools list inside a subpackage.

Parameter

Type

Description

package_key required

string

Subpackage key

Next steps

On this page