7x Developer Portal & API Documentation

Loading developer portal

Preparing the API reference and documentation.

Overview

Retrieves renewal eligibility, subscription context, and customer data for guest users. Supports renewal, upgrade, and subscription-change scenarios before pricing or save.

Request builder

Reference details

Query Parameters

BoxNumber?integer

Formatint32

EmirateCode?string

IsChangeSubscriptionOnly?boolean

resellerId?string

api-version?string

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/Guest/Renewal/Details"

{  "isSuccess": true,  "responseMessage": "string",  "responseCode": 0,  "errorDetail": {    "httpStatusCode": "string",    "poBoxErrorCode": "string",    "displayMessage": "string"  },  "poBoxRenewalDetails": {    "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"    },    "poBoxAddressDetails": {      "custProfId": "string",      "fullName": "string",      "email": "string",      "mobileNumber": "string",      "countryCode": "string",      "cityCode": "string",      "region": "string",      "street": "string",      "buildingName": "string",      "apartmentNo": "string",      "addressDetails": "string"    },    "boxAgentDetail": [      {        "agentId": 0,        "emailId": "string",        "mobileNo": "string",        "attachments": [          {            "attachmentName": "string",            "attachment": "string",            "fileFormat": "string",            "attachmentType": "Unknown"          }        ],        "emiratesId": "string",        "emirateCode": "string",        "idExpiryDate": "2019-08-24T14:15:22Z",        "agentFullNameEn": "string",        "agentFullNameAr": "string",        "agentStatus": "Active",        "approvalMessage": "string"      }    ]  }}

{  "type": "string",  "title": "string",  "status": 0,  "detail": "string",  "instance": "string",  "errors": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "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`