### GET /api/residential-unlim/packages/{package}

Source: https://api.proxyma.io/api/reseller/docs

Retrieves data for a user's purchased Residential Unlim package.

```APIDOC
## GET /api/residential-unlim/packages/{package}

### Description
Retrieves data for a user's purchased Residential Unlim package.

### Method
GET

### Endpoint
/api/residential-unlim/packages/{package}

### Parameters
#### Path Parameters
- **package** (string) - Required - The ID of the package.

### Request Example
(No request body needed for GET request)

### Response
#### Success Response (200)
- **packages** (array) - An array of package objects.
  - **id** (integer) - The package ID.
  - **name** (string) - The name of the package.
  - **price** (integer) - The price of the package.
  - **speed_limit** (integer) - The speed limit of the package.
  - **duration_days** (integer) - The duration of the package in days.
  - **status** (string) - The status of the package.
  - **created_at** (string) - The timestamp when the package was created.
  - **updated_at** (string) - The timestamp when the package was last updated.

#### Response Example
```json
{
    "packages": [
        {
            "id": 1,
            "name": "string",
            "price": 1,
            "speed_limit": 1,
            "duration_days": 1,
            "status": "string",
            "created_at": "string",
            "updated_at": "string"
        }
    ]
}
```

#### Error Response (401)
- **message** (string) - Error message indicating unauthorized access.

#### Error Response (422)
- **message** (string) - Error message indicating validation failure.
- **errors** (object) - An object containing validation errors for specific fields.
  - **field_name** (array of strings) - An array of error messages for the field.
```

--------------------------------

### Get Residential Unlim Package Data

Source: https://api.proxyma.io/api/reseller/docs

This endpoint retrieves data for a user's purchased Residential Unlim package. It requires a package ID in the path and returns details about the package, including its ID, name, price, speed limit, duration, status, and timestamps.

```json
{
    "packages": [
        {
            "id": 1,
            "name": "string",
            "price": 1,
            "speed_limit": 1,
            "duration_days": 1,
            "status": "string",
            "created_at": "string",
            "updated_at": "string"
        }
    ]
}
```

--------------------------------

### POST /api/residential-unlim/{package}/renew

Source: https://api.proxyma.io/api/reseller/docs

Renews a Residential Unlim package. Allows for applying a promo code.

```APIDOC
## POST /api/residential-unlim/{package}/renew

### Description
Renews a Residential Unlim package. Optionally, a promo code can be applied for renewal.

### Method
POST

### Endpoint
/api/residential-unlim/{package}/renew

### Parameters
#### Path Parameters
- **package** (string) - Required - ID of the package to renew

#### Request Body
- **promo** (string) - Optional - Promo code to apply for renewal

### Request Example
```json
{
  "promo": "SUMMER2023"
}
```

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the renewal was successful
- **message** (integer) - A message or status code related to the renewal (nullable)

#### Response Example
```json
{
  "success": true,
  "message": "Successfully renewed"
}
```

#### Error Response (402)
- Description: Insufficient funds
- Content: application/json
  - Schema: properties: { message: { type: string, example: "Insufficient funds." } }, type: object

#### Error Example (402)
```json
{
  "message": "Insufficient funds."
}
```
```

--------------------------------

### DELETE /api/residential-unlim/{package}

Source: https://api.proxyma.io/api/reseller/docs

Deletes a Residential Unlim package by its ID. Requires authentication.

```APIDOC
## DELETE /api/residential-unlim/{package}

### Description
Deletes a Residential Unlim package by its ID.

### Method
DELETE

### Endpoint
/api/residential-unlim/{package}

### Parameters
#### Path Parameters
- **package** (string) - Required - ID of the package to delete

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the deletion was successful

#### Response Example
```json
{
  "success": true
}
```

#### Error Response (401)
- **message** (string) - Error message indicating unauthorized access

#### Error Example (401)
```json
{
  "message": "Unauthenticated."
}
```
```

--------------------------------

### Renew Residential Unlimited Package API

Source: https://api.proxyma.io/api/reseller/docs

This endpoint enables the renewal of a residential unlimited package. It requires the package ID as a path parameter and an optional 'promo' code in the request body. Successful renewal returns a success boolean and a message. Insufficient funds will result in a 402 error.

```json
{
    "/api/residential-unlim/{package}/renew": {
        "post": {
            "tags": [
                "Residential Unlim"
            ],
            "summary": "Продлить пакет",
            "operationId": "1b74b86743ddc972fc98a2e11477fa2e",
            "parameters": [
                {
                    "name": "package",
                    "in": "path",
                    "description": "ID пакета",
                    "required": true
                }
            ],
            "requestBody": {
                "content": {
                    "application/json": {
                        "schema": {
                            "properties": {
                                "promo": {
                                    "type": "string"
                                }
                            },
                            "type": "object"
                        }
                    }
                }
            },
            "responses": {
                "200": {
                    "description": "Успешное продление тарифа",
                    "content": {
                        "application/json": {
                            "schema": {
                                "required": [
                                    "success",
                                    "message"
                                ],
                                "properties": {
                                    "success": {
                                        "type": "boolean"
                                    },
                                    "message": {
                                        "type": "integer",
                                        "example": "Успешно",
                                        "nullable": true
                                    }
                                },
                                "type": "object"
                            }
                        }
                    }
                },
                "402": {
                    "description": "Недостаточно средств",
                    "content": {
                        "application/json": {
                            "schema": {
                                "properties": {
                                    "message": {
                                        "type": "string",
                                        "example": "Unauthenticated."
                                    }
                                },
                                "type": "object"
                            }
                        }
                    }
                }
            }
        }
    }
}
```

--------------------------------

### Delete Residential Unlim Packages

Source: https://api.proxyma.io/api/reseller/docs

This endpoint is used to successfully delete residential unlimited packages. It returns a JSON object indicating the success of the operation.

```json
{
    "success": true
}
```

--------------------------------

### Delete Residential Unlimited Package API

Source: https://api.proxyma.io/api/reseller/docs

This endpoint allows for the deletion of a residential unlimited package. It requires a package ID as a path parameter and returns a success boolean upon successful deletion. Unauthenticated requests will result in a 401 error.

```json
{
    "delete": {
        "tags": [
            "Residential Unlim"
        ],
        "summary": "Удалить пакет",
        "operationId": "6a2868f86198583eccc274707be9af00",
        "parameters": [
            {
                "name": "package",
                "in": "path",
                "description": "ID пакета",
                "required": true
            }
        ],
        "responses": {
            "200": {
                "description": "Успешное удаление",
                "content": {
                    "application/json": {
                        "schema": {
                            "required": [
                                "success"
                            ],
                            "properties": {
                                "success": {
                                    "type": "boolean"
                                }
                            },
                            "type": "object"
                        }
                    }
                }
            },
            "401": {
                "description": "Не авторизован",
                "content": {
                    "application/json": {
                        "schema": {
                            "properties": {
                                "message": {
                                    "type": "string",
                                    "example": "Unauthenticated."
                                }
                            },
                            "type": "object"
                        }
                    }
                }
            }
        }
    }
}
```

--------------------------------

### Unauthorized Access Message

Source: https://api.proxyma.io/api/reseller/docs

This JSON response indicates an unauthorized access attempt, typically returning a message like 'Unauthenticated.'

```json
{
    "message": "Unauthenticated."
}
```

--------------------------------

### Validation Error Message

Source: https://api.proxyma.io/api/reseller/docs

This JSON response signifies a validation error, providing a general error message and specific details about invalid fields.

```json
{
    "message": "The given data was invalid.",
    "errors": {
        "field_name": [
            "The field_name field is required."
        ]
    }
}
```

=== COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.