> For the complete documentation index, see [llms.txt](https://docs.goproxies.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.goproxies.com/proxies/resellers-api-v3/reference/resellers.md).

# Resellers

## Subscriptions

## List reseller subscriptions

> Subscriptions owned by the caller with quota usage and sub-user capacity

````json
{"openapi":"3.0.3","info":{"title":"Ragutis","version":"1.0.0"},"tags":[{"description":"Manage subscriptions, sub-users and sub-user quotas of a reseller account.","name":"Resellers"}],"servers":[{"url":"/"}],"security":[{"userBearerAuth":[]}],"components":{"securitySchemes":{"userBearerAuth":{"bearerFormat":"JWT","description":"Bearer authentication with sentinel token for users.\n\nYou can use the following command to get the bearer token:\n\n```\ncurl -d '{\"username\":\"<username>\", \"password\":\"<password>\", \"pool\":\"<pool>\"}' -H \"Content-Type: application/json\" -X POST -s https://<sentinel/sentinel-testnet>.mysterium.network/api/v1/auth/password | jq -r '.auth_token'\n```\n\nSubstitute `<username>`, `<password>` and `<pool>` with your credentials.\nUse `sentinel` or `sentinel-testnet` as depending on the environment.\n","scheme":"bearer","type":"http"}},"schemas":{"ResellerSubscriptionV3":{"properties":{"active":{"type":"boolean"},"created_at":{"format":"date-time","type":"string"},"id":{"type":"string"},"plan_id":{"type":"string"},"product_id":{"type":"string"},"quota_gb":{"type":"number"},"quota_period_end":{"format":"date-time","type":"string"},"quota_period_seconds":{"type":"integer"},"quota_period_start":{"format":"date-time","type":"string"},"quota_remaining_gb":{"type":"number"},"quota_used_gb":{"type":"number"},"recurring":{"type":"boolean"},"sub_user_limit":{"type":"integer"},"sub_users_available":{"type":"integer"},"sub_users_count":{"type":"integer"}},"required":["id","product_id","plan_id","active","recurring","quota_gb","quota_used_gb","quota_remaining_gb","quota_period_start","quota_period_end","quota_period_seconds","sub_user_limit","sub_users_count","sub_users_available","created_at"],"type":"object"},"Error":{"properties":{"error":{"$ref":"#/components/schemas/Err"},"path":{"type":"string"},"status":{"type":"integer"}}},"Err":{"properties":{"code":{"type":"string"},"detail":{"type":"string"},"fields":{"additionalProperties":{"$ref":"#/components/schemas/FieldError"},"type":"object"},"message":{"type":"string"}}},"FieldError":{"properties":{"code":{"type":"string"},"message":{"type":"string"}}}}},"paths":{"/api/v3/reseller/subscriptions":{"get":{"description":"Subscriptions owned by the caller with quota usage and sub-user capacity","operationId":"resellerV3ListSubscriptions","parameters":[{"description":"Include inactive subscriptions","in":"query","name":"include_inactive","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/ResellerSubscriptionV3"},"type":"array"}}},"description":"OK"},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"unexpected error"}},"summary":"List reseller subscriptions","tags":["Resellers"]}}}}
````

## GET /api/v3/reseller/subscriptions/{subscription\_id}

> Get reseller subscription

````json
{"openapi":"3.0.3","info":{"title":"Ragutis","version":"1.0.0"},"tags":[{"description":"Manage subscriptions, sub-users and sub-user quotas of a reseller account.","name":"Resellers"}],"servers":[{"url":"/"}],"security":[{"userBearerAuth":[]}],"components":{"securitySchemes":{"userBearerAuth":{"bearerFormat":"JWT","description":"Bearer authentication with sentinel token for users.\n\nYou can use the following command to get the bearer token:\n\n```\ncurl -d '{\"username\":\"<username>\", \"password\":\"<password>\", \"pool\":\"<pool>\"}' -H \"Content-Type: application/json\" -X POST -s https://<sentinel/sentinel-testnet>.mysterium.network/api/v1/auth/password | jq -r '.auth_token'\n```\n\nSubstitute `<username>`, `<password>` and `<pool>` with your credentials.\nUse `sentinel` or `sentinel-testnet` as depending on the environment.\n","scheme":"bearer","type":"http"}},"schemas":{"ResellerSubscriptionV3":{"properties":{"active":{"type":"boolean"},"created_at":{"format":"date-time","type":"string"},"id":{"type":"string"},"plan_id":{"type":"string"},"product_id":{"type":"string"},"quota_gb":{"type":"number"},"quota_period_end":{"format":"date-time","type":"string"},"quota_period_seconds":{"type":"integer"},"quota_period_start":{"format":"date-time","type":"string"},"quota_remaining_gb":{"type":"number"},"quota_used_gb":{"type":"number"},"recurring":{"type":"boolean"},"sub_user_limit":{"type":"integer"},"sub_users_available":{"type":"integer"},"sub_users_count":{"type":"integer"}},"required":["id","product_id","plan_id","active","recurring","quota_gb","quota_used_gb","quota_remaining_gb","quota_period_start","quota_period_end","quota_period_seconds","sub_user_limit","sub_users_count","sub_users_available","created_at"],"type":"object"},"Error":{"properties":{"error":{"$ref":"#/components/schemas/Err"},"path":{"type":"string"},"status":{"type":"integer"}}},"Err":{"properties":{"code":{"type":"string"},"detail":{"type":"string"},"fields":{"additionalProperties":{"$ref":"#/components/schemas/FieldError"},"type":"object"},"message":{"type":"string"}}},"FieldError":{"properties":{"code":{"type":"string"},"message":{"type":"string"}}}}},"paths":{"/api/v3/reseller/subscriptions/{subscription_id}":{"get":{"operationId":"resellerV3GetSubscription","parameters":[{"in":"path","name":"subscription_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResellerSubscriptionV3"}}},"description":"OK"},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"unexpected error"}},"summary":"Get reseller subscription","tags":["Resellers"]}}}}
````

## Sub-users

## List sub-users across all subscriptions

> All sub-users of the reseller, newest first. By default only sub-users assigned to a subscription are listed;\
> \`include\_unassigned=true\` also lists legacy sub-users that are not assigned to any subscription.<br>

````json
{"openapi":"3.0.3","info":{"title":"Ragutis","version":"1.0.0"},"tags":[{"description":"Manage subscriptions, sub-users and sub-user quotas of a reseller account.","name":"Resellers"}],"servers":[{"url":"/"}],"security":[{"userBearerAuth":[]}],"components":{"securitySchemes":{"userBearerAuth":{"bearerFormat":"JWT","description":"Bearer authentication with sentinel token for users.\n\nYou can use the following command to get the bearer token:\n\n```\ncurl -d '{\"username\":\"<username>\", \"password\":\"<password>\", \"pool\":\"<pool>\"}' -H \"Content-Type: application/json\" -X POST -s https://<sentinel/sentinel-testnet>.mysterium.network/api/v1/auth/password | jq -r '.auth_token'\n```\n\nSubstitute `<username>`, `<password>` and `<pool>` with your credentials.\nUse `sentinel` or `sentinel-testnet` as depending on the environment.\n","scheme":"bearer","type":"http"}},"schemas":{"ResellerSubusersV3Response":{"properties":{"cursor":{"type":"string"},"items":{"items":{"$ref":"#/components/schemas/ResellerSubuserV3"},"type":"array"}},"required":["items"],"type":"object"},"ResellerSubuserV3":{"properties":{"blocked":{"type":"boolean"},"blocked_reason":{"type":"string"},"created_at":{"format":"date-time","type":"string"},"enabled":{"type":"boolean"},"id":{"type":"string"},"quota":{"$ref":"#/components/schemas/SubuserQuotaV3"},"quota_used_gb":{"description":"Traffic used by the sub-user (refreshed every few minutes).\nIf `quota` is present, counted within the quota's current period; otherwise within the account's current quota period.\n","type":"number"},"subscription_id":{"description":"Subscription the sub-user draws traffic from. `null` for unassigned (legacy) sub-users, which use the newest active subscription.","nullable":true,"type":"string"},"username":{"type":"string"}},"required":["id","username","subscription_id","enabled","blocked","created_at","quota_used_gb"],"type":"object"},"SubuserQuotaV3":{"properties":{"created_at":{"format":"date-time","type":"string"},"period_seconds":{"description":"Absent for a lifetime quota","type":"integer"},"period_start_at":{"format":"date-time","type":"string"},"quota_gb":{"type":"number"},"recurring":{"type":"boolean"},"updated_at":{"format":"date-time","type":"string"}},"required":["quota_gb","period_start_at","recurring","created_at","updated_at"],"type":"object"},"Error":{"properties":{"error":{"$ref":"#/components/schemas/Err"},"path":{"type":"string"},"status":{"type":"integer"}}},"Err":{"properties":{"code":{"type":"string"},"detail":{"type":"string"},"fields":{"additionalProperties":{"$ref":"#/components/schemas/FieldError"},"type":"object"},"message":{"type":"string"}}},"FieldError":{"properties":{"code":{"type":"string"},"message":{"type":"string"}}}}},"paths":{"/api/v3/reseller/subusers":{"get":{"description":"All sub-users of the reseller, newest first. By default only sub-users assigned to a subscription are listed;\n`include_unassigned=true` also lists legacy sub-users that are not assigned to any subscription.\n","operationId":"resellerV3ListAllSubusers","parameters":[{"description":"Exact username","in":"query","name":"username","required":false,"schema":{"type":"string"}},{"in":"query","name":"subscription_id","required":false,"schema":{"type":"string"}},{"in":"query","name":"enabled","required":false,"schema":{"type":"boolean"}},{"description":"Also list sub-users not assigned to any subscription","in":"query","name":"include_unassigned","required":false,"schema":{"default":false,"type":"boolean"}},{"description":"default 100, max 1000","in":"query","name":"per_page","required":false,"schema":{"type":"integer"}},{"description":"Cursor obtained from previous response","in":"query","name":"page_cursor","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResellerSubusersV3Response"}}},"description":"OK"},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"unexpected error"}},"summary":"List sub-users across all subscriptions","tags":["Resellers"]}}}}
````

## GET /api/v3/reseller/subscriptions/{subscription\_id}/subusers

> List sub-users of a subscription

````json
{"openapi":"3.0.3","info":{"title":"Ragutis","version":"1.0.0"},"tags":[{"description":"Manage subscriptions, sub-users and sub-user quotas of a reseller account.","name":"Resellers"}],"servers":[{"url":"/"}],"security":[{"userBearerAuth":[]}],"components":{"securitySchemes":{"userBearerAuth":{"bearerFormat":"JWT","description":"Bearer authentication with sentinel token for users.\n\nYou can use the following command to get the bearer token:\n\n```\ncurl -d '{\"username\":\"<username>\", \"password\":\"<password>\", \"pool\":\"<pool>\"}' -H \"Content-Type: application/json\" -X POST -s https://<sentinel/sentinel-testnet>.mysterium.network/api/v1/auth/password | jq -r '.auth_token'\n```\n\nSubstitute `<username>`, `<password>` and `<pool>` with your credentials.\nUse `sentinel` or `sentinel-testnet` as depending on the environment.\n","scheme":"bearer","type":"http"}},"schemas":{"ResellerSubusersV3Response":{"properties":{"cursor":{"type":"string"},"items":{"items":{"$ref":"#/components/schemas/ResellerSubuserV3"},"type":"array"}},"required":["items"],"type":"object"},"ResellerSubuserV3":{"properties":{"blocked":{"type":"boolean"},"blocked_reason":{"type":"string"},"created_at":{"format":"date-time","type":"string"},"enabled":{"type":"boolean"},"id":{"type":"string"},"quota":{"$ref":"#/components/schemas/SubuserQuotaV3"},"quota_used_gb":{"description":"Traffic used by the sub-user (refreshed every few minutes).\nIf `quota` is present, counted within the quota's current period; otherwise within the account's current quota period.\n","type":"number"},"subscription_id":{"description":"Subscription the sub-user draws traffic from. `null` for unassigned (legacy) sub-users, which use the newest active subscription.","nullable":true,"type":"string"},"username":{"type":"string"}},"required":["id","username","subscription_id","enabled","blocked","created_at","quota_used_gb"],"type":"object"},"SubuserQuotaV3":{"properties":{"created_at":{"format":"date-time","type":"string"},"period_seconds":{"description":"Absent for a lifetime quota","type":"integer"},"period_start_at":{"format":"date-time","type":"string"},"quota_gb":{"type":"number"},"recurring":{"type":"boolean"},"updated_at":{"format":"date-time","type":"string"}},"required":["quota_gb","period_start_at","recurring","created_at","updated_at"],"type":"object"},"Error":{"properties":{"error":{"$ref":"#/components/schemas/Err"},"path":{"type":"string"},"status":{"type":"integer"}}},"Err":{"properties":{"code":{"type":"string"},"detail":{"type":"string"},"fields":{"additionalProperties":{"$ref":"#/components/schemas/FieldError"},"type":"object"},"message":{"type":"string"}}},"FieldError":{"properties":{"code":{"type":"string"},"message":{"type":"string"}}}}},"paths":{"/api/v3/reseller/subscriptions/{subscription_id}/subusers":{"get":{"operationId":"resellerV3ListSubusers","parameters":[{"in":"path","name":"subscription_id","required":true,"schema":{"type":"string"}},{"description":"Exact username","in":"query","name":"username","required":false,"schema":{"type":"string"}},{"in":"query","name":"enabled","required":false,"schema":{"type":"boolean"}},{"description":"default 100, max 1000","in":"query","name":"per_page","required":false,"schema":{"type":"integer"}},{"description":"Cursor obtained from previous response","in":"query","name":"page_cursor","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResellerSubusersV3Response"}}},"description":"OK"},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"unexpected error"}},"summary":"List sub-users of a subscription","tags":["Resellers"]}}}}
````

## POST /api/v3/reseller/subscriptions/{subscription\_id}/subusers

> Create sub-user in a subscription

````json
{"openapi":"3.0.3","info":{"title":"Ragutis","version":"1.0.0"},"tags":[{"description":"Manage subscriptions, sub-users and sub-user quotas of a reseller account.","name":"Resellers"}],"servers":[{"url":"/"}],"security":[{"userBearerAuth":[]}],"components":{"securitySchemes":{"userBearerAuth":{"bearerFormat":"JWT","description":"Bearer authentication with sentinel token for users.\n\nYou can use the following command to get the bearer token:\n\n```\ncurl -d '{\"username\":\"<username>\", \"password\":\"<password>\", \"pool\":\"<pool>\"}' -H \"Content-Type: application/json\" -X POST -s https://<sentinel/sentinel-testnet>.mysterium.network/api/v1/auth/password | jq -r '.auth_token'\n```\n\nSubstitute `<username>`, `<password>` and `<pool>` with your credentials.\nUse `sentinel` or `sentinel-testnet` as depending on the environment.\n","scheme":"bearer","type":"http"}},"schemas":{"ResellerCreateSubuserV3Request":{"properties":{"username":{"type":"string"}},"required":["username"],"type":"object"},"ResellerSubuserV3WithSecret":{"allOf":[{"$ref":"#/components/schemas/ResellerSubuserV3"},{"properties":{"secret":{"type":"string"}},"required":["secret"],"type":"object"}]},"ResellerSubuserV3":{"properties":{"blocked":{"type":"boolean"},"blocked_reason":{"type":"string"},"created_at":{"format":"date-time","type":"string"},"enabled":{"type":"boolean"},"id":{"type":"string"},"quota":{"$ref":"#/components/schemas/SubuserQuotaV3"},"quota_used_gb":{"description":"Traffic used by the sub-user (refreshed every few minutes).\nIf `quota` is present, counted within the quota's current period; otherwise within the account's current quota period.\n","type":"number"},"subscription_id":{"description":"Subscription the sub-user draws traffic from. `null` for unassigned (legacy) sub-users, which use the newest active subscription.","nullable":true,"type":"string"},"username":{"type":"string"}},"required":["id","username","subscription_id","enabled","blocked","created_at","quota_used_gb"],"type":"object"},"SubuserQuotaV3":{"properties":{"created_at":{"format":"date-time","type":"string"},"period_seconds":{"description":"Absent for a lifetime quota","type":"integer"},"period_start_at":{"format":"date-time","type":"string"},"quota_gb":{"type":"number"},"recurring":{"type":"boolean"},"updated_at":{"format":"date-time","type":"string"}},"required":["quota_gb","period_start_at","recurring","created_at","updated_at"],"type":"object"},"Error":{"properties":{"error":{"$ref":"#/components/schemas/Err"},"path":{"type":"string"},"status":{"type":"integer"}}},"Err":{"properties":{"code":{"type":"string"},"detail":{"type":"string"},"fields":{"additionalProperties":{"$ref":"#/components/schemas/FieldError"},"type":"object"},"message":{"type":"string"}}},"FieldError":{"properties":{"code":{"type":"string"},"message":{"type":"string"}}}}},"paths":{"/api/v3/reseller/subscriptions/{subscription_id}/subusers":{"post":{"operationId":"resellerV3CreateSubuser","parameters":[{"in":"path","name":"subscription_id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResellerCreateSubuserV3Request"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResellerSubuserV3WithSecret"}}},"description":"OK"},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"unexpected error"}},"summary":"Create sub-user in a subscription","tags":["Resellers"]}}}}
````

## GET /api/v3/reseller/subscriptions/{subscription\_id}/subusers/{subuser\_id}

> Get sub-user

````json
{"openapi":"3.0.3","info":{"title":"Ragutis","version":"1.0.0"},"tags":[{"description":"Manage subscriptions, sub-users and sub-user quotas of a reseller account.","name":"Resellers"}],"servers":[{"url":"/"}],"security":[{"userBearerAuth":[]}],"components":{"securitySchemes":{"userBearerAuth":{"bearerFormat":"JWT","description":"Bearer authentication with sentinel token for users.\n\nYou can use the following command to get the bearer token:\n\n```\ncurl -d '{\"username\":\"<username>\", \"password\":\"<password>\", \"pool\":\"<pool>\"}' -H \"Content-Type: application/json\" -X POST -s https://<sentinel/sentinel-testnet>.mysterium.network/api/v1/auth/password | jq -r '.auth_token'\n```\n\nSubstitute `<username>`, `<password>` and `<pool>` with your credentials.\nUse `sentinel` or `sentinel-testnet` as depending on the environment.\n","scheme":"bearer","type":"http"}},"schemas":{"ResellerSubuserV3":{"properties":{"blocked":{"type":"boolean"},"blocked_reason":{"type":"string"},"created_at":{"format":"date-time","type":"string"},"enabled":{"type":"boolean"},"id":{"type":"string"},"quota":{"$ref":"#/components/schemas/SubuserQuotaV3"},"quota_used_gb":{"description":"Traffic used by the sub-user (refreshed every few minutes).\nIf `quota` is present, counted within the quota's current period; otherwise within the account's current quota period.\n","type":"number"},"subscription_id":{"description":"Subscription the sub-user draws traffic from. `null` for unassigned (legacy) sub-users, which use the newest active subscription.","nullable":true,"type":"string"},"username":{"type":"string"}},"required":["id","username","subscription_id","enabled","blocked","created_at","quota_used_gb"],"type":"object"},"SubuserQuotaV3":{"properties":{"created_at":{"format":"date-time","type":"string"},"period_seconds":{"description":"Absent for a lifetime quota","type":"integer"},"period_start_at":{"format":"date-time","type":"string"},"quota_gb":{"type":"number"},"recurring":{"type":"boolean"},"updated_at":{"format":"date-time","type":"string"}},"required":["quota_gb","period_start_at","recurring","created_at","updated_at"],"type":"object"},"Error":{"properties":{"error":{"$ref":"#/components/schemas/Err"},"path":{"type":"string"},"status":{"type":"integer"}}},"Err":{"properties":{"code":{"type":"string"},"detail":{"type":"string"},"fields":{"additionalProperties":{"$ref":"#/components/schemas/FieldError"},"type":"object"},"message":{"type":"string"}}},"FieldError":{"properties":{"code":{"type":"string"},"message":{"type":"string"}}}}},"paths":{"/api/v3/reseller/subscriptions/{subscription_id}/subusers/{subuser_id}":{"get":{"operationId":"resellerV3GetSubuser","parameters":[{"in":"path","name":"subscription_id","required":true,"schema":{"type":"string"}},{"in":"path","name":"subuser_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResellerSubuserV3"}}},"description":"OK"},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"unexpected error"}},"summary":"Get sub-user","tags":["Resellers"]}}}}
````

## PATCH /api/v3/reseller/subscriptions/{subscription\_id}/subusers/{subuser\_id}

> Update sub-user

````json
{"openapi":"3.0.3","info":{"title":"Ragutis","version":"1.0.0"},"tags":[{"description":"Manage subscriptions, sub-users and sub-user quotas of a reseller account.","name":"Resellers"}],"servers":[{"url":"/"}],"security":[{"userBearerAuth":[]}],"components":{"securitySchemes":{"userBearerAuth":{"bearerFormat":"JWT","description":"Bearer authentication with sentinel token for users.\n\nYou can use the following command to get the bearer token:\n\n```\ncurl -d '{\"username\":\"<username>\", \"password\":\"<password>\", \"pool\":\"<pool>\"}' -H \"Content-Type: application/json\" -X POST -s https://<sentinel/sentinel-testnet>.mysterium.network/api/v1/auth/password | jq -r '.auth_token'\n```\n\nSubstitute `<username>`, `<password>` and `<pool>` with your credentials.\nUse `sentinel` or `sentinel-testnet` as depending on the environment.\n","scheme":"bearer","type":"http"}},"schemas":{"ResellerUpdateSubuserV3Request":{"properties":{"enabled":{"type":"boolean"}},"required":["enabled"],"type":"object"},"ResellerSubuserV3":{"properties":{"blocked":{"type":"boolean"},"blocked_reason":{"type":"string"},"created_at":{"format":"date-time","type":"string"},"enabled":{"type":"boolean"},"id":{"type":"string"},"quota":{"$ref":"#/components/schemas/SubuserQuotaV3"},"quota_used_gb":{"description":"Traffic used by the sub-user (refreshed every few minutes).\nIf `quota` is present, counted within the quota's current period; otherwise within the account's current quota period.\n","type":"number"},"subscription_id":{"description":"Subscription the sub-user draws traffic from. `null` for unassigned (legacy) sub-users, which use the newest active subscription.","nullable":true,"type":"string"},"username":{"type":"string"}},"required":["id","username","subscription_id","enabled","blocked","created_at","quota_used_gb"],"type":"object"},"SubuserQuotaV3":{"properties":{"created_at":{"format":"date-time","type":"string"},"period_seconds":{"description":"Absent for a lifetime quota","type":"integer"},"period_start_at":{"format":"date-time","type":"string"},"quota_gb":{"type":"number"},"recurring":{"type":"boolean"},"updated_at":{"format":"date-time","type":"string"}},"required":["quota_gb","period_start_at","recurring","created_at","updated_at"],"type":"object"},"Error":{"properties":{"error":{"$ref":"#/components/schemas/Err"},"path":{"type":"string"},"status":{"type":"integer"}}},"Err":{"properties":{"code":{"type":"string"},"detail":{"type":"string"},"fields":{"additionalProperties":{"$ref":"#/components/schemas/FieldError"},"type":"object"},"message":{"type":"string"}}},"FieldError":{"properties":{"code":{"type":"string"},"message":{"type":"string"}}}}},"paths":{"/api/v3/reseller/subscriptions/{subscription_id}/subusers/{subuser_id}":{"patch":{"operationId":"resellerV3UpdateSubuser","parameters":[{"in":"path","name":"subscription_id","required":true,"schema":{"type":"string"}},{"in":"path","name":"subuser_id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResellerUpdateSubuserV3Request"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResellerSubuserV3"}}},"description":"OK"},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"unexpected error"}},"summary":"Update sub-user","tags":["Resellers"]}}}}
````

## POST /api/v3/reseller/subscriptions/{subscription\_id}/subusers/{subuser\_id}/reset-secret

> Reset sub-user secret

````json
{"openapi":"3.0.3","info":{"title":"Ragutis","version":"1.0.0"},"tags":[{"description":"Manage subscriptions, sub-users and sub-user quotas of a reseller account.","name":"Resellers"}],"servers":[{"url":"/"}],"security":[{"userBearerAuth":[]}],"components":{"securitySchemes":{"userBearerAuth":{"bearerFormat":"JWT","description":"Bearer authentication with sentinel token for users.\n\nYou can use the following command to get the bearer token:\n\n```\ncurl -d '{\"username\":\"<username>\", \"password\":\"<password>\", \"pool\":\"<pool>\"}' -H \"Content-Type: application/json\" -X POST -s https://<sentinel/sentinel-testnet>.mysterium.network/api/v1/auth/password | jq -r '.auth_token'\n```\n\nSubstitute `<username>`, `<password>` and `<pool>` with your credentials.\nUse `sentinel` or `sentinel-testnet` as depending on the environment.\n","scheme":"bearer","type":"http"}},"schemas":{"ResellerSubuserV3WithSecret":{"allOf":[{"$ref":"#/components/schemas/ResellerSubuserV3"},{"properties":{"secret":{"type":"string"}},"required":["secret"],"type":"object"}]},"ResellerSubuserV3":{"properties":{"blocked":{"type":"boolean"},"blocked_reason":{"type":"string"},"created_at":{"format":"date-time","type":"string"},"enabled":{"type":"boolean"},"id":{"type":"string"},"quota":{"$ref":"#/components/schemas/SubuserQuotaV3"},"quota_used_gb":{"description":"Traffic used by the sub-user (refreshed every few minutes).\nIf `quota` is present, counted within the quota's current period; otherwise within the account's current quota period.\n","type":"number"},"subscription_id":{"description":"Subscription the sub-user draws traffic from. `null` for unassigned (legacy) sub-users, which use the newest active subscription.","nullable":true,"type":"string"},"username":{"type":"string"}},"required":["id","username","subscription_id","enabled","blocked","created_at","quota_used_gb"],"type":"object"},"SubuserQuotaV3":{"properties":{"created_at":{"format":"date-time","type":"string"},"period_seconds":{"description":"Absent for a lifetime quota","type":"integer"},"period_start_at":{"format":"date-time","type":"string"},"quota_gb":{"type":"number"},"recurring":{"type":"boolean"},"updated_at":{"format":"date-time","type":"string"}},"required":["quota_gb","period_start_at","recurring","created_at","updated_at"],"type":"object"},"Error":{"properties":{"error":{"$ref":"#/components/schemas/Err"},"path":{"type":"string"},"status":{"type":"integer"}}},"Err":{"properties":{"code":{"type":"string"},"detail":{"type":"string"},"fields":{"additionalProperties":{"$ref":"#/components/schemas/FieldError"},"type":"object"},"message":{"type":"string"}}},"FieldError":{"properties":{"code":{"type":"string"},"message":{"type":"string"}}}}},"paths":{"/api/v3/reseller/subscriptions/{subscription_id}/subusers/{subuser_id}/reset-secret":{"post":{"operationId":"resellerV3ResetSubuserSecret","parameters":[{"in":"path","name":"subscription_id","required":true,"schema":{"type":"string"}},{"in":"path","name":"subuser_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResellerSubuserV3WithSecret"}}},"description":"OK"},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"unexpected error"}},"summary":"Reset sub-user secret","tags":["Resellers"]}}}}
````

## DELETE /api/v3/reseller/subscriptions/{subscription\_id}/subusers/{subuser\_id}

> Delete sub-user

````json
{"openapi":"3.0.3","info":{"title":"Ragutis","version":"1.0.0"},"tags":[{"description":"Manage subscriptions, sub-users and sub-user quotas of a reseller account.","name":"Resellers"}],"servers":[{"url":"/"}],"security":[{"userBearerAuth":[]}],"components":{"securitySchemes":{"userBearerAuth":{"bearerFormat":"JWT","description":"Bearer authentication with sentinel token for users.\n\nYou can use the following command to get the bearer token:\n\n```\ncurl -d '{\"username\":\"<username>\", \"password\":\"<password>\", \"pool\":\"<pool>\"}' -H \"Content-Type: application/json\" -X POST -s https://<sentinel/sentinel-testnet>.mysterium.network/api/v1/auth/password | jq -r '.auth_token'\n```\n\nSubstitute `<username>`, `<password>` and `<pool>` with your credentials.\nUse `sentinel` or `sentinel-testnet` as depending on the environment.\n","scheme":"bearer","type":"http"}},"schemas":{"Error":{"properties":{"error":{"$ref":"#/components/schemas/Err"},"path":{"type":"string"},"status":{"type":"integer"}}},"Err":{"properties":{"code":{"type":"string"},"detail":{"type":"string"},"fields":{"additionalProperties":{"$ref":"#/components/schemas/FieldError"},"type":"object"},"message":{"type":"string"}}},"FieldError":{"properties":{"code":{"type":"string"},"message":{"type":"string"}}}}},"paths":{"/api/v3/reseller/subscriptions/{subscription_id}/subusers/{subuser_id}":{"delete":{"operationId":"resellerV3DeleteSubuser","parameters":[{"in":"path","name":"subscription_id","required":true,"schema":{"type":"string"}},{"in":"path","name":"subuser_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Deleted"},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"unexpected error"}},"summary":"Delete sub-user","tags":["Resellers"]}}}}
````

## Sub-user quotas

## List sub-user quotas

> Sub-users that have their own quota. A sub-user without a quota only shares its subscription's quota.

````json
{"openapi":"3.0.3","info":{"title":"Ragutis","version":"1.0.0"},"tags":[{"description":"Manage subscriptions, sub-users and sub-user quotas of a reseller account.","name":"Resellers"}],"servers":[{"url":"/"}],"security":[{"userBearerAuth":[]}],"components":{"securitySchemes":{"userBearerAuth":{"bearerFormat":"JWT","description":"Bearer authentication with sentinel token for users.\n\nYou can use the following command to get the bearer token:\n\n```\ncurl -d '{\"username\":\"<username>\", \"password\":\"<password>\", \"pool\":\"<pool>\"}' -H \"Content-Type: application/json\" -X POST -s https://<sentinel/sentinel-testnet>.mysterium.network/api/v1/auth/password | jq -r '.auth_token'\n```\n\nSubstitute `<username>`, `<password>` and `<pool>` with your credentials.\nUse `sentinel` or `sentinel-testnet` as depending on the environment.\n","scheme":"bearer","type":"http"}},"schemas":{"SubuserQuotasV3Response":{"properties":{"cursor":{"type":"string"},"items":{"items":{"$ref":"#/components/schemas/SubuserQuotaDetailsV3"},"type":"array"}},"required":["items"],"type":"object"},"SubuserQuotaDetailsV3":{"allOf":[{"$ref":"#/components/schemas/SubuserQuotaV3"},{"properties":{"subuser_id":{"type":"string"},"used_gb":{"description":"Traffic used within the quota's current period (refreshed every few minutes)","type":"number"},"username":{"type":"string"}},"required":["subuser_id","username","used_gb"],"type":"object"}]},"SubuserQuotaV3":{"properties":{"created_at":{"format":"date-time","type":"string"},"period_seconds":{"description":"Absent for a lifetime quota","type":"integer"},"period_start_at":{"format":"date-time","type":"string"},"quota_gb":{"type":"number"},"recurring":{"type":"boolean"},"updated_at":{"format":"date-time","type":"string"}},"required":["quota_gb","period_start_at","recurring","created_at","updated_at"],"type":"object"},"Error":{"properties":{"error":{"$ref":"#/components/schemas/Err"},"path":{"type":"string"},"status":{"type":"integer"}}},"Err":{"properties":{"code":{"type":"string"},"detail":{"type":"string"},"fields":{"additionalProperties":{"$ref":"#/components/schemas/FieldError"},"type":"object"},"message":{"type":"string"}}},"FieldError":{"properties":{"code":{"type":"string"},"message":{"type":"string"}}}}},"paths":{"/api/v3/reseller/subuser-quotas":{"get":{"description":"Sub-users that have their own quota. A sub-user without a quota only shares its subscription's quota.","operationId":"resellerV3ListSubuserQuotas","parameters":[{"description":"Exact username","in":"query","name":"username","required":false,"schema":{"type":"string"}},{"in":"query","name":"recurring","required":false,"schema":{"type":"boolean"}},{"description":"Quota used up, or a non-recurring period has ended","in":"query","name":"exceeded","required":false,"schema":{"type":"boolean"}},{"description":"default 100, max 1000","in":"query","name":"per_page","required":false,"schema":{"type":"integer"}},{"description":"Cursor obtained from previous response","in":"query","name":"page_cursor","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubuserQuotasV3Response"}}},"description":"OK"},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"unexpected error"}},"summary":"List sub-user quotas","tags":["Resellers"]}}}}
````

## Give a sub-user its own quota

> The sub-user is blocked once it uses \`quota\_gb\` within its period, on top of its subscription's limits.\
> Without \`period\_seconds\` the quota counts lifetime traffic (up to 450 days back).\
> A non-recurring quota whose period has ended keeps the sub-user blocked until the quota is changed or removed.<br>

````json
{"openapi":"3.0.3","info":{"title":"Ragutis","version":"1.0.0"},"tags":[{"description":"Manage subscriptions, sub-users and sub-user quotas of a reseller account.","name":"Resellers"}],"servers":[{"url":"/"}],"security":[{"userBearerAuth":[]}],"components":{"securitySchemes":{"userBearerAuth":{"bearerFormat":"JWT","description":"Bearer authentication with sentinel token for users.\n\nYou can use the following command to get the bearer token:\n\n```\ncurl -d '{\"username\":\"<username>\", \"password\":\"<password>\", \"pool\":\"<pool>\"}' -H \"Content-Type: application/json\" -X POST -s https://<sentinel/sentinel-testnet>.mysterium.network/api/v1/auth/password | jq -r '.auth_token'\n```\n\nSubstitute `<username>`, `<password>` and `<pool>` with your credentials.\nUse `sentinel` or `sentinel-testnet` as depending on the environment.\n","scheme":"bearer","type":"http"}},"schemas":{"CreateSubuserQuotaV3Request":{"properties":{"period_seconds":{"description":"At least 3600. Omit for a lifetime quota.","type":"integer"},"period_start_at":{"description":"Defaults to now. Must not be in the future.","format":"date-time","type":"string"},"quota_gb":{"description":"Greater than 0","type":"number"},"recurring":{"description":"Start a new period automatically when one ends. Requires period_seconds.","type":"boolean"},"subuser_id":{"type":"string"}},"required":["subuser_id","quota_gb"],"type":"object"},"SubuserQuotaDetailsV3":{"allOf":[{"$ref":"#/components/schemas/SubuserQuotaV3"},{"properties":{"subuser_id":{"type":"string"},"used_gb":{"description":"Traffic used within the quota's current period (refreshed every few minutes)","type":"number"},"username":{"type":"string"}},"required":["subuser_id","username","used_gb"],"type":"object"}]},"SubuserQuotaV3":{"properties":{"created_at":{"format":"date-time","type":"string"},"period_seconds":{"description":"Absent for a lifetime quota","type":"integer"},"period_start_at":{"format":"date-time","type":"string"},"quota_gb":{"type":"number"},"recurring":{"type":"boolean"},"updated_at":{"format":"date-time","type":"string"}},"required":["quota_gb","period_start_at","recurring","created_at","updated_at"],"type":"object"},"Error":{"properties":{"error":{"$ref":"#/components/schemas/Err"},"path":{"type":"string"},"status":{"type":"integer"}}},"Err":{"properties":{"code":{"type":"string"},"detail":{"type":"string"},"fields":{"additionalProperties":{"$ref":"#/components/schemas/FieldError"},"type":"object"},"message":{"type":"string"}}},"FieldError":{"properties":{"code":{"type":"string"},"message":{"type":"string"}}}}},"paths":{"/api/v3/reseller/subuser-quotas":{"post":{"description":"The sub-user is blocked once it uses `quota_gb` within its period, on top of its subscription's limits.\nWithout `period_seconds` the quota counts lifetime traffic (up to 450 days back).\nA non-recurring quota whose period has ended keeps the sub-user blocked until the quota is changed or removed.\n","operationId":"resellerV3CreateSubuserQuota","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateSubuserQuotaV3Request"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubuserQuotaDetailsV3"}}},"description":"OK"},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"unexpected error"}},"summary":"Give a sub-user its own quota","tags":["Resellers"]}}}}
````

## GET /api/v3/reseller/subuser-quotas/{subuser\_id}

> Get a sub-user quota

````json
{"openapi":"3.0.3","info":{"title":"Ragutis","version":"1.0.0"},"tags":[{"description":"Manage subscriptions, sub-users and sub-user quotas of a reseller account.","name":"Resellers"}],"servers":[{"url":"/"}],"security":[{"userBearerAuth":[]}],"components":{"securitySchemes":{"userBearerAuth":{"bearerFormat":"JWT","description":"Bearer authentication with sentinel token for users.\n\nYou can use the following command to get the bearer token:\n\n```\ncurl -d '{\"username\":\"<username>\", \"password\":\"<password>\", \"pool\":\"<pool>\"}' -H \"Content-Type: application/json\" -X POST -s https://<sentinel/sentinel-testnet>.mysterium.network/api/v1/auth/password | jq -r '.auth_token'\n```\n\nSubstitute `<username>`, `<password>` and `<pool>` with your credentials.\nUse `sentinel` or `sentinel-testnet` as depending on the environment.\n","scheme":"bearer","type":"http"}},"schemas":{"SubuserQuotaDetailsV3":{"allOf":[{"$ref":"#/components/schemas/SubuserQuotaV3"},{"properties":{"subuser_id":{"type":"string"},"used_gb":{"description":"Traffic used within the quota's current period (refreshed every few minutes)","type":"number"},"username":{"type":"string"}},"required":["subuser_id","username","used_gb"],"type":"object"}]},"SubuserQuotaV3":{"properties":{"created_at":{"format":"date-time","type":"string"},"period_seconds":{"description":"Absent for a lifetime quota","type":"integer"},"period_start_at":{"format":"date-time","type":"string"},"quota_gb":{"type":"number"},"recurring":{"type":"boolean"},"updated_at":{"format":"date-time","type":"string"}},"required":["quota_gb","period_start_at","recurring","created_at","updated_at"],"type":"object"},"Error":{"properties":{"error":{"$ref":"#/components/schemas/Err"},"path":{"type":"string"},"status":{"type":"integer"}}},"Err":{"properties":{"code":{"type":"string"},"detail":{"type":"string"},"fields":{"additionalProperties":{"$ref":"#/components/schemas/FieldError"},"type":"object"},"message":{"type":"string"}}},"FieldError":{"properties":{"code":{"type":"string"},"message":{"type":"string"}}}}},"paths":{"/api/v3/reseller/subuser-quotas/{subuser_id}":{"get":{"operationId":"resellerV3GetSubuserQuota","parameters":[{"in":"path","name":"subuser_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubuserQuotaDetailsV3"}}},"description":"OK"},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"unexpected error"}},"summary":"Get a sub-user quota","tags":["Resellers"]}}}}
````

## Update a sub-user quota

> Changing \`period\_start\_at\` or \`period\_seconds\` recalculates usage over the new window, so it can go down or up.

````json
{"openapi":"3.0.3","info":{"title":"Ragutis","version":"1.0.0"},"tags":[{"description":"Manage subscriptions, sub-users and sub-user quotas of a reseller account.","name":"Resellers"}],"servers":[{"url":"/"}],"security":[{"userBearerAuth":[]}],"components":{"securitySchemes":{"userBearerAuth":{"bearerFormat":"JWT","description":"Bearer authentication with sentinel token for users.\n\nYou can use the following command to get the bearer token:\n\n```\ncurl -d '{\"username\":\"<username>\", \"password\":\"<password>\", \"pool\":\"<pool>\"}' -H \"Content-Type: application/json\" -X POST -s https://<sentinel/sentinel-testnet>.mysterium.network/api/v1/auth/password | jq -r '.auth_token'\n```\n\nSubstitute `<username>`, `<password>` and `<pool>` with your credentials.\nUse `sentinel` or `sentinel-testnet` as depending on the environment.\n","scheme":"bearer","type":"http"}},"schemas":{"UpdateSubuserQuotaV3Request":{"properties":{"period_seconds":{"description":"0 removes the period (lifetime quota)","type":"integer"},"period_start_at":{"format":"date-time","type":"string"},"quota_gb":{"type":"number"},"recurring":{"type":"boolean"}},"type":"object"},"SubuserQuotaDetailsV3":{"allOf":[{"$ref":"#/components/schemas/SubuserQuotaV3"},{"properties":{"subuser_id":{"type":"string"},"used_gb":{"description":"Traffic used within the quota's current period (refreshed every few minutes)","type":"number"},"username":{"type":"string"}},"required":["subuser_id","username","used_gb"],"type":"object"}]},"SubuserQuotaV3":{"properties":{"created_at":{"format":"date-time","type":"string"},"period_seconds":{"description":"Absent for a lifetime quota","type":"integer"},"period_start_at":{"format":"date-time","type":"string"},"quota_gb":{"type":"number"},"recurring":{"type":"boolean"},"updated_at":{"format":"date-time","type":"string"}},"required":["quota_gb","period_start_at","recurring","created_at","updated_at"],"type":"object"},"Error":{"properties":{"error":{"$ref":"#/components/schemas/Err"},"path":{"type":"string"},"status":{"type":"integer"}}},"Err":{"properties":{"code":{"type":"string"},"detail":{"type":"string"},"fields":{"additionalProperties":{"$ref":"#/components/schemas/FieldError"},"type":"object"},"message":{"type":"string"}}},"FieldError":{"properties":{"code":{"type":"string"},"message":{"type":"string"}}}}},"paths":{"/api/v3/reseller/subuser-quotas/{subuser_id}":{"patch":{"description":"Changing `period_start_at` or `period_seconds` recalculates usage over the new window, so it can go down or up.","operationId":"resellerV3UpdateSubuserQuota","parameters":[{"in":"path","name":"subuser_id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateSubuserQuotaV3Request"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubuserQuotaDetailsV3"}}},"description":"OK"},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"unexpected error"}},"summary":"Update a sub-user quota","tags":["Resellers"]}}}}
````

## DELETE /api/v3/reseller/subuser-quotas/{subuser\_id}

> Remove a sub-user quota

````json
{"openapi":"3.0.3","info":{"title":"Ragutis","version":"1.0.0"},"tags":[{"description":"Manage subscriptions, sub-users and sub-user quotas of a reseller account.","name":"Resellers"}],"servers":[{"url":"/"}],"security":[{"userBearerAuth":[]}],"components":{"securitySchemes":{"userBearerAuth":{"bearerFormat":"JWT","description":"Bearer authentication with sentinel token for users.\n\nYou can use the following command to get the bearer token:\n\n```\ncurl -d '{\"username\":\"<username>\", \"password\":\"<password>\", \"pool\":\"<pool>\"}' -H \"Content-Type: application/json\" -X POST -s https://<sentinel/sentinel-testnet>.mysterium.network/api/v1/auth/password | jq -r '.auth_token'\n```\n\nSubstitute `<username>`, `<password>` and `<pool>` with your credentials.\nUse `sentinel` or `sentinel-testnet` as depending on the environment.\n","scheme":"bearer","type":"http"}},"schemas":{"Error":{"properties":{"error":{"$ref":"#/components/schemas/Err"},"path":{"type":"string"},"status":{"type":"integer"}}},"Err":{"properties":{"code":{"type":"string"},"detail":{"type":"string"},"fields":{"additionalProperties":{"$ref":"#/components/schemas/FieldError"},"type":"object"},"message":{"type":"string"}}},"FieldError":{"properties":{"code":{"type":"string"},"message":{"type":"string"}}}}},"paths":{"/api/v3/reseller/subuser-quotas/{subuser_id}":{"delete":{"operationId":"resellerV3DeleteSubuserQuota","parameters":[{"in":"path","name":"subuser_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK"},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"unexpected error"}},"summary":"Remove a sub-user quota","tags":["Resellers"]}}}}
````


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.goproxies.com/proxies/resellers-api-v3/reference/resellers.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
