> 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/models.md).

# Models

## The CreateSubuserQuotaV3Request object

```json
{"openapi":"3.0.3","info":{"title":"Ragutis","version":"1.0.0"},"components":{"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"}}}}
```

## The Err object

```json
{"openapi":"3.0.3","info":{"title":"Ragutis","version":"1.0.0"},"components":{"schemas":{"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"}}}}}}
```

## The Error object

```json
{"openapi":"3.0.3","info":{"title":"Ragutis","version":"1.0.0"},"components":{"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"}}}}}}
```

## The FieldError object

```json
{"openapi":"3.0.3","info":{"title":"Ragutis","version":"1.0.0"},"components":{"schemas":{"FieldError":{"properties":{"code":{"type":"string"},"message":{"type":"string"}}}}}}
```

## The LoginRequest object

```json
{"openapi":"3.0.3","info":{"title":"Ragutis","version":"1.0.0"},"components":{"schemas":{"LoginRequest":{"properties":{"password":{"type":"string"},"username":{"type":"string"}},"required":["username","password"]}}}}
```

## The ResellerCreateSubuserV3Request object

```json
{"openapi":"3.0.3","info":{"title":"Ragutis","version":"1.0.0"},"components":{"schemas":{"ResellerCreateSubuserV3Request":{"properties":{"username":{"type":"string"}},"required":["username"],"type":"object"}}}}
```

## The ResellerSubscriptionV3 object

```json
{"openapi":"3.0.3","info":{"title":"Ragutis","version":"1.0.0"},"components":{"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"}}}}
```

## The ResellerSubuserV3 object

```json
{"openapi":"3.0.3","info":{"title":"Ragutis","version":"1.0.0"},"components":{"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"}}}}
```

## The ResellerSubuserV3WithSecret object

```json
{"openapi":"3.0.3","info":{"title":"Ragutis","version":"1.0.0"},"components":{"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"}}}}
```

## The ResellerSubusersV3Response object

```json
{"openapi":"3.0.3","info":{"title":"Ragutis","version":"1.0.0"},"components":{"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"}}}}
```

## The ResellerUpdateSubuserV3Request object

```json
{"openapi":"3.0.3","info":{"title":"Ragutis","version":"1.0.0"},"components":{"schemas":{"ResellerUpdateSubuserV3Request":{"properties":{"enabled":{"type":"boolean"}},"required":["enabled"],"type":"object"}}}}
```

## The StatsV3Countries object

```json
{"openapi":"3.0.3","info":{"title":"Ragutis","version":"1.0.0"},"components":{"schemas":{"StatsV3Countries":{"properties":{"countries":{"items":{"$ref":"#/components/schemas/StatsV3Country"},"type":"array"},"filter":{"$ref":"#/components/schemas/StatsV3Filter"}},"required":["filter","countries"],"type":"object"},"StatsV3Country":{"properties":{"bytes":{"format":"int64","type":"integer"},"country":{"type":"string"}},"required":["country","bytes"],"type":"object"},"StatsV3Filter":{"properties":{"country":{"type":"string"},"from":{"format":"date-time","type":"string"},"interval":{"$ref":"#/components/schemas/StatsV3Interval"},"plan_id":{"type":"string"},"product_id":{"type":"string"},"status":{"items":{"type":"integer"},"type":"array"},"status_not":{"items":{"type":"integer"},"type":"array"},"subscription_id":{"type":"string"},"to":{"format":"date-time","type":"string"},"username":{"items":{"type":"string"},"type":"array"}},"required":["from","to"],"type":"object"},"StatsV3Interval":{"default":"day","enum":["hour","day","week"],"type":"string"}}}}
```

## The StatsV3Country object

```json
{"openapi":"3.0.3","info":{"title":"Ragutis","version":"1.0.0"},"components":{"schemas":{"StatsV3Country":{"properties":{"bytes":{"format":"int64","type":"integer"},"country":{"type":"string"}},"required":["country","bytes"],"type":"object"}}}}
```

## The StatsV3Domain object

```json
{"openapi":"3.0.3","info":{"title":"Ragutis","version":"1.0.0"},"components":{"schemas":{"StatsV3Domain":{"properties":{"domain":{"type":"string"},"failed":{"format":"int64","type":"integer"},"succeeded":{"format":"int64","type":"integer"}},"required":["domain","succeeded","failed"],"type":"object"}}}}
```

## The StatsV3Domains object

```json
{"openapi":"3.0.3","info":{"title":"Ragutis","version":"1.0.0"},"components":{"schemas":{"StatsV3Domains":{"properties":{"domains":{"items":{"$ref":"#/components/schemas/StatsV3Domain"},"type":"array"},"filter":{"$ref":"#/components/schemas/StatsV3Filter"}},"required":["filter","domains"],"type":"object"},"StatsV3Domain":{"properties":{"domain":{"type":"string"},"failed":{"format":"int64","type":"integer"},"succeeded":{"format":"int64","type":"integer"}},"required":["domain","succeeded","failed"],"type":"object"},"StatsV3Filter":{"properties":{"country":{"type":"string"},"from":{"format":"date-time","type":"string"},"interval":{"$ref":"#/components/schemas/StatsV3Interval"},"plan_id":{"type":"string"},"product_id":{"type":"string"},"status":{"items":{"type":"integer"},"type":"array"},"status_not":{"items":{"type":"integer"},"type":"array"},"subscription_id":{"type":"string"},"to":{"format":"date-time","type":"string"},"username":{"items":{"type":"string"},"type":"array"}},"required":["from","to"],"type":"object"},"StatsV3Interval":{"default":"day","enum":["hour","day","week"],"type":"string"}}}}
```

## The StatsV3FailedReason object

```json
{"openapi":"3.0.3","info":{"title":"Ragutis","version":"1.0.0"},"components":{"schemas":{"StatsV3FailedReason":{"properties":{"count":{"format":"int64","type":"integer"},"message":{"type":"string"},"status":{"type":"string"}},"required":["status","message","count"],"type":"object"}}}}
```

## The StatsV3Filter object

```json
{"openapi":"3.0.3","info":{"title":"Ragutis","version":"1.0.0"},"components":{"schemas":{"StatsV3Filter":{"properties":{"country":{"type":"string"},"from":{"format":"date-time","type":"string"},"interval":{"$ref":"#/components/schemas/StatsV3Interval"},"plan_id":{"type":"string"},"product_id":{"type":"string"},"status":{"items":{"type":"integer"},"type":"array"},"status_not":{"items":{"type":"integer"},"type":"array"},"subscription_id":{"type":"string"},"to":{"format":"date-time","type":"string"},"username":{"items":{"type":"string"},"type":"array"}},"required":["from","to"],"type":"object"},"StatsV3Interval":{"default":"day","enum":["hour","day","week"],"type":"string"}}}}
```

## The StatsV3Interval object

```json
{"openapi":"3.0.3","info":{"title":"Ragutis","version":"1.0.0"},"components":{"schemas":{"StatsV3Interval":{"default":"day","enum":["hour","day","week"],"type":"string"}}}}
```

## The StatsV3Requests object

```json
{"openapi":"3.0.3","info":{"title":"Ragutis","version":"1.0.0"},"components":{"schemas":{"StatsV3Requests":{"properties":{"buckets":{"items":{"$ref":"#/components/schemas/StatsV3RequestsBucket"},"type":"array"},"failed":{"format":"int64","type":"integer"},"failed_reasons":{"items":{"$ref":"#/components/schemas/StatsV3FailedReason"},"type":"array"},"filter":{"$ref":"#/components/schemas/StatsV3Filter"},"succeeded":{"format":"int64","type":"integer"}},"required":["filter","succeeded","failed","buckets","failed_reasons"],"type":"object"},"StatsV3RequestsBucket":{"properties":{"end":{"format":"date-time","type":"string"},"failed":{"format":"int64","type":"integer"},"partial":{"description":"The bucket reaches into the current 10-minute slot, so its value can still grow","type":"boolean"},"start":{"format":"date-time","type":"string"},"succeeded":{"format":"int64","type":"integer"}},"required":["start","end","succeeded","failed","partial"],"type":"object"},"StatsV3FailedReason":{"properties":{"count":{"format":"int64","type":"integer"},"message":{"type":"string"},"status":{"type":"string"}},"required":["status","message","count"],"type":"object"},"StatsV3Filter":{"properties":{"country":{"type":"string"},"from":{"format":"date-time","type":"string"},"interval":{"$ref":"#/components/schemas/StatsV3Interval"},"plan_id":{"type":"string"},"product_id":{"type":"string"},"status":{"items":{"type":"integer"},"type":"array"},"status_not":{"items":{"type":"integer"},"type":"array"},"subscription_id":{"type":"string"},"to":{"format":"date-time","type":"string"},"username":{"items":{"type":"string"},"type":"array"}},"required":["from","to"],"type":"object"},"StatsV3Interval":{"default":"day","enum":["hour","day","week"],"type":"string"}}}}
```

## The StatsV3RequestsBucket object

```json
{"openapi":"3.0.3","info":{"title":"Ragutis","version":"1.0.0"},"components":{"schemas":{"StatsV3RequestsBucket":{"properties":{"end":{"format":"date-time","type":"string"},"failed":{"format":"int64","type":"integer"},"partial":{"description":"The bucket reaches into the current 10-minute slot, so its value can still grow","type":"boolean"},"start":{"format":"date-time","type":"string"},"succeeded":{"format":"int64","type":"integer"}},"required":["start","end","succeeded","failed","partial"],"type":"object"}}}}
```

## The StatsV3SubUserTraffic object

```json
{"openapi":"3.0.3","info":{"title":"Ragutis","version":"1.0.0"},"components":{"schemas":{"StatsV3SubUserTraffic":{"properties":{"buckets":{"items":{"$ref":"#/components/schemas/StatsV3TrafficBucket"},"type":"array"},"bytes":{"format":"int64","type":"integer"},"username":{"type":"string"}},"required":["username","bytes","buckets"],"type":"object"},"StatsV3TrafficBucket":{"properties":{"bytes":{"format":"int64","type":"integer"},"end":{"format":"date-time","type":"string"},"partial":{"description":"The bucket reaches into the current 10-minute slot, so its value can still grow","type":"boolean"},"start":{"format":"date-time","type":"string"}},"required":["start","end","bytes","partial"],"type":"object"}}}}
```

## The StatsV3Traffic object

```json
{"openapi":"3.0.3","info":{"title":"Ragutis","version":"1.0.0"},"components":{"schemas":{"StatsV3Traffic":{"properties":{"buckets":{"items":{"$ref":"#/components/schemas/StatsV3TrafficBucket"},"type":"array"},"bytes":{"format":"int64","type":"integer"},"filter":{"$ref":"#/components/schemas/StatsV3Filter"},"subusers":{"description":"Present with `group_by=subuser`. Only sub-users with traffic in the range are listed.","items":{"$ref":"#/components/schemas/StatsV3SubUserTraffic"},"type":"array"}},"required":["filter","bytes","buckets"],"type":"object"},"StatsV3TrafficBucket":{"properties":{"bytes":{"format":"int64","type":"integer"},"end":{"format":"date-time","type":"string"},"partial":{"description":"The bucket reaches into the current 10-minute slot, so its value can still grow","type":"boolean"},"start":{"format":"date-time","type":"string"}},"required":["start","end","bytes","partial"],"type":"object"},"StatsV3Filter":{"properties":{"country":{"type":"string"},"from":{"format":"date-time","type":"string"},"interval":{"$ref":"#/components/schemas/StatsV3Interval"},"plan_id":{"type":"string"},"product_id":{"type":"string"},"status":{"items":{"type":"integer"},"type":"array"},"status_not":{"items":{"type":"integer"},"type":"array"},"subscription_id":{"type":"string"},"to":{"format":"date-time","type":"string"},"username":{"items":{"type":"string"},"type":"array"}},"required":["from","to"],"type":"object"},"StatsV3Interval":{"default":"day","enum":["hour","day","week"],"type":"string"},"StatsV3SubUserTraffic":{"properties":{"buckets":{"items":{"$ref":"#/components/schemas/StatsV3TrafficBucket"},"type":"array"},"bytes":{"format":"int64","type":"integer"},"username":{"type":"string"}},"required":["username","bytes","buckets"],"type":"object"}}}}
```

## The StatsV3TrafficBucket object

```json
{"openapi":"3.0.3","info":{"title":"Ragutis","version":"1.0.0"},"components":{"schemas":{"StatsV3TrafficBucket":{"properties":{"bytes":{"format":"int64","type":"integer"},"end":{"format":"date-time","type":"string"},"partial":{"description":"The bucket reaches into the current 10-minute slot, so its value can still grow","type":"boolean"},"start":{"format":"date-time","type":"string"}},"required":["start","end","bytes","partial"],"type":"object"}}}}
```

## The Status object

```json
{"openapi":"3.0.3","info":{"title":"Ragutis","version":"1.0.0"},"components":{"schemas":{"Status":{"properties":{"db_status":{"type":"string"}},"required":["db_status"]}}}}
```

## The SubuserQuotaDetailsV3 object

```json
{"openapi":"3.0.3","info":{"title":"Ragutis","version":"1.0.0"},"components":{"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"}}}}
```

## The SubuserQuotaV3 object

```json
{"openapi":"3.0.3","info":{"title":"Ragutis","version":"1.0.0"},"components":{"schemas":{"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"}}}}
```

## The SubuserQuotasV3Response object

```json
{"openapi":"3.0.3","info":{"title":"Ragutis","version":"1.0.0"},"components":{"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"}}}}
```

## The Token object

```json
{"openapi":"3.0.3","info":{"title":"Ragutis","version":"1.0.0"},"components":{"schemas":{"Token":{"properties":{"token":{"type":"string"}},"required":["token"]}}}}
```

## The UpdateSubuserQuotaV3Request object

```json
{"openapi":"3.0.3","info":{"title":"Ragutis","version":"1.0.0"},"components":{"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"}}}}
```


---

# 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/models.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.
