7x Developer Portal & API Documentation

Loading developer portal

Preparing the API reference and documentation.

Overview

Returns renewal details in rental context, including upgrade-only and bundle-change options. Used when transitioning an existing rental into a renewal decision flow.

Request builder

Reference details

Query Parameters

BoxNumber?string

NewBundleId?string

EmirateCode?string

IsUpgradeOnly?boolean

api-version?string

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/Rental/renewaldetails"

{  "message": "string",  "payload": {    "poBoxDetails": {      "boxNumber": "string",      "emirate": "string",      "boxStatus": "string",      "revenueOfficeId": "string",      "officeId": "string",      "uniqueBoxId": "string",      "assignedOfficeName": "string",      "isAgencyBox": true,      "isAutoRenewEnabled": true    },    "poBoxSubscriptionDetails": {      "bundle": "string",      "bundleDesc": "string",      "currentExpiryDate": "2019-08-24T14:15:22Z",      "rentType": "string",      "isBundleAvailable": true,      "listPossibleBundles": [        {          "bundleId": "string",          "bundleName": "string",          "bundleDescription": "string",          "features": [            "string"          ],          "rentType": "string",          "yearlyPrice": "string",          "bundle24Month_Price": "string",          "bundle36Month_Price": "string",          "bundle60Month_Price": "string",          "bundle120Month_Price": "string",          "upgradePrice": 0.1,          "isUpgrade": true,          "actualUpgradePriceToCurrentExpiryDate": 0.1        }      ],      "currentBundle": {        "bundleId": "string",        "bundleName": "string",        "bundleDescription": "string",        "features": [          "string"        ],        "rentType": "string",        "yearlyPrice": "string",        "bundle24Month_Price": "string",        "bundle36Month_Price": "string",        "bundle60Month_Price": "string",        "bundle120Month_Price": "string",        "upgradePrice": 0.1,        "isUpgrade": true,        "actualUpgradePriceToCurrentExpiryDate": 0.1      },      "isRenewable": true,      "isUpgradeOnlyPossible": true,      "isChangeSubscriptionPossible": true,      "listNoChangeSubscriptionPossible": [        "string"      ],      "isCancellationAllowed": true,      "listNonCancellationAllowedReason": [        "string"      ],      "listNonRenewableReason": [        "string"      ],      "listNonUpgradeOnlyReason": [        "string"      ],      "possibleExpiryDates": {        "listExpiryDates": [          "2019-08-24T14:15:22Z"        ],        "maxExpiryDate": "2019-08-24T14:15:22Z",        "minExpiryDate": "2019-08-24T14:15:22Z",        "dateType": "string"      }    },    "poBoxCustomerDetails": {      "customerName": "string",      "mobileNumber": "string",      "email": "string",      "tradeLicenseNo": "string",      "emirateOfIssue": "string",      "sponsor": "string",      "tradeLicenseExpiryDate": "string",      "tradeLicenseIssueEntity": "string"    }  },  "responseCode": "Continue",  "errorDetails": {    "property1": null,    "property2": null  }}

{  "message": "string",  "payload": null,  "responseCode": "Continue",  "errorDetails": {    "property1": null,    "property2": null  }}

{  "type": "string",  "title": "string",  "status": 0,  "detail": "string",  "instance": "string",  "property1": null,  "property2": null}

{  "type": "string",  "title": "string",  "status": 0,  "detail": "string",  "instance": "string",  "property1": null,  "property2": null}

Query Parameters

Response Body

200application/json

400application/json

404application/json

500application/json

Query Parameters

Response Body

200application/json

400application/json

404application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`