# Rental Conditions

GET /partner/v3/shops/:shopUuid/rental/products/:productCode/detailed-asset-model?
identifierType=:identifierType&identifier=:identifier

The e-shop can retrieve the rental product conditions for each product model using this API request.
The response includes the minimum and maximum product price values, available rental periods, add-on price range, etc.
These values can then be used to initiate a session with Inbank.
Additionally, the response contains assetIdentifierTypes, which define the required identifiers needed to activate the contract after the rental product is issued.

The request URL includes the product codes provided by Inbank.
NB! The product code for the Demo and Live environments may differ!
The query includes the type of model identifier and the identifier value ("EAN" or "MANUFACTURER_PRODUCT_CODE"). Only models that have been pre-approved and priced by Inbank will get a response. NB! In Demo environment only limited list of models are available.
Applicable models are agreed prior to launch and shared with Inbank via a MS Excel file, for which we will provide the template and assist if needed. Only hero device are required, add-ons you will be able to post depending on customer selection (within agreed categories and min/max agreed for each category prior to launch).

There are two options for hero device pricing setup:

- Preferred option: We agree on a fixed price for Inbank Rent for the month (or longer) for the selected hero device. In this case, there is no need to send us the existing retail price over API, but we will provide you a monthly rental payment based on the agreed fixed price for the period.
- Alternative option: Not fixing the prices for Inbank Rent. In this case, you will send us a valid retail net price during contract creation and, based on it, get back a monthly rental payment.

Endpoint: GET /partner/v3/shops/{shopUuid}/rental/products/{productCode}/detailed-asset-model
Security: bearerAuth

## Path parameters:

  - `shopUuid` (string, required)
    Example: "a93f1f44-d5dd-4469-bfcc-c1de9e969213"

  - `productCode` (string, required)
    Example: "example_code"

## Query parameters:

  - `identifierType` (string, required)
    Example: "EAN"

  - `identifier` (string, required)
    Example: 88845632734657

## Response 200 fields (application/json):

  - `id` (string)
    Rental product code.

  - `name` (string)
    Rental product name.

  - `periods` (array)
    Rental periods.

  - `assetIdentifierTypes` (array)
    Asset identifier types. Possible values are IMEI and SERIAL_NUMBER.

  - `identifiers` (any)
    The identifier type.
    Enum: "EAN", "MANUFACTURER_PRODUCT_CODE"

  - `subscriptionTotalLimits` (object)

  - `subscriptionTotalLimits.minNetPrice` (number)
    Minimum net price.

  - `subscriptionTotalLimits.maxNetPrice` (number)
    Maximum net price.

  - `subscriptionTotalLimits.minGrossPrice` (number)
    Minimum gross price.

  - `subscriptionTotalLimits.maxGrossPrice` (number)
    Maximum gross price.

  - `insuranceRequirement` (string)
    Information on whether insurance is required.
    Enum: "INSURANCE_NEVER_APPLIED", "INSURANCE_OPTIONAL", "INSURANCE_ALWAYS_APPLIED"

  - `tradeInAvailable` (boolean)
    Whether trade in is available.

  - `campaignDiscountAvailable` (boolean)
    Whether the campaign discount is available.

  - `addOnCategories` (array)

  - `addOnCategories.[0]` (object)

  - `addOnCategories.[0].assetType` (string)
    Type of the asset.

  - `addOnCategories.[0].code` (string)
    Asset code.

  - `addOnCategories.[0].name` (string)
    Asset name.

  - `addOnCategories.[0].type` (string)
    Asset type.

  - `addOnCategories.[0].minPrice` (number)
    Asset minimum price.

  - `addOnCategories.[0].maxPrice` (number)
    Asset maximum price.

  - `addOnCategories.[0].minNetPrice` (number)
    Asset minimum net price.

  - `addOnCategories.[0].maxNetPrice` (number)
    Asset maximum net price.

  - `addOnCategories.[0].minGrossPrice` (number)
    Asset minimum gross price.

  - `addOnCategories.[0].maxGrossPrice` (number)
    Asset maximum gross price.

  - `addOnCategories.[0].assetIdentifierRequired` (boolean)
    Whether the asset identifier is required.

## Response 401 fields (application/json):

  - `message` (string)
    Unauthorized
    Example: "unauthorized"

## Response 403 fields (application/json):

  - `message` (string)
    Unauthorized access
    Example: "User is not authorized to access this resource with an explicit deny"

## Response 404 fields (application/json):

  - `message` (string)
    Not Found
    Example: "not_found"

## Response 500 fields (application/json):

  - `message` (string)
    Internal server error
    Example: "internal_server_error"