1. IP Orders
Nstdata Resell Service API
  • Nstdata Resell API
    • Zones
      • Get service zone list
    • Channels
      • Get channel usage statistics
      • Get total usage for all service channels
      • Create channel
      • Batch query channels
      • Batch query channel usage summary
      • Get channel detail
      • Update channel
      • Delete channel
    • IP Products
      • Get service IP product list
    • IP Orders
      • Get total purchased IP quantity
        GET
      • Batch query IP orders
        POST
      • Buy service IPs
        POST
      • Get purchased IP order detail
        GET
      • Renew IP order
        POST
    • Regions
      • Get country list
    • Proxies
      • Generate proxies
    • Schemas
      • SuccessResponse
      • ErrorResponse
      • ProxyType
      • RegionProxyType
      • IpOrderType
      • ProxyProtocol
      • Zone
      • Channel
      • CreateChannelRequest
      • UpdateChannelRequest
      • ChannelIdsRequest
      • ChannelUsageRequest
      • ChannelStatistics
      • UsageMetric
      • ChannelUsageTotal
      • ChannelUsageSummary
      • IpProduct
      • PurchaseTotalByType
      • PurchaseTotal
      • OrderIdsRequest
      • IpProxyItem
      • IpOrder
      • IpOrderDetail
      • CreateIpOrderProduct
      • CreateIpOrderRequest
      • ErrorProxyItem
      • CreateIpOrderResponse
      • RenewSuccessItem
      • RenewIpOrderResponse
      • Country
      • GenerateProxiesResponse
  • Cloud Browser Developer API
    • Automation Access
      • Get CDP Credentials for an Existing Session
    • Session Configuration
      • Get Available Options
      • Estimate Browser Runtime Cost
    • Session Management
      • Create Browser Session
      • List Browser Sessions
      • Get Session Details and Status
      • Rename Browser Session
      • Stop Browser Session
    • Connection Credentials
      • Get Live View Credentials
    • Configuration Details
      • Get Session Configuration
    • Usage and Costs
      • Get Session Usage and Costs
      • Get Costs for Multiple Sessions
      • Get All Session Statistics
      • Get Historical Session Statistics
    • Schemas
      • BrowserConnectionResponseDto
      • BrowserOptionsResponseDto
      • BrowserErrorDto
      • SharedStorageErrorDto
      • SharedHttpErrorDto
      • BrowserEstimateDto
      • BrowserQuoteResponseDto
      • CreateBrowserDto
      • BrowserSessionResponseDto
      • BrowserListResponseDto
      • RenameBrowserDto
      • BrowserNameResponseDto
      • BrowserLiveViewResponseDto
      • BrowserConfigurationResponseDto
      • BrowserCostsResponseDto
      • BrowserCostsBatchDto
      • BrowserCostsBatchResponseDto
      • BrowserStatisticsResponseDto
      • BrowserHistoryStatisticsResponseDto
      • BrowserOptionsDto
      • BrowserQuoteDto
      • BrowserExtensionDto
      • BrowserCaptchaSettingsDto
      • BrowserFingerprintDto
      • BrowserSessionDto
      • BrowserListDto
      • BrowserNameDto
      • BrowserConnectionDto
      • BrowserLiveViewDto
      • BrowserConfigurationDto
      • BrowserCostsDto
      • BrowserCostsBatchDataDto
      • BrowserStatisticsDto
      • BrowserHistoryStatisticsDto
      • BrowserScreenOptionsDto
      • BrowserRecordingOptionsDto
      • BrowserFingerprintPresetDto
      • BrowserProxyCountryOptionDto
      • BrowserResourceClassOptionDto
      • BrowserCaptchaTypesDto
      • BrowserResolutionOptionDto
      • BrowserRecordingAvailabilityDto
      • BrowserProviderObservationDto
      • BrowserCaptchaPublicDto
      • BrowserEffectiveConfigurationDto
      • BrowserRequestedConfigurationDto
      • BrowserResolvedConfigurationDto
      • BrowserRuntimeCostDto
      • BrowserProxyCostDto
      • BrowserCaptchaCostDto
      • BrowserScreenRangeDto
      • BrowserNetworkIdentityDto
      • BrowserEffectiveExtensionDto
      • BrowserEffectiveFingerprintDto
      • BrowserConfigurationExtensionDto
      • BrowserResolvedFingerprintDto
      • BrowserIpAlignmentDto
  1. IP Orders

Renew IP order

POST
/api/v1/service/purchase/ip/{orderId}/renew

Insufficient inventory (PRODUCT_OOS)#

HTTP statusBusiness error codeDescription
400PRODUCT_OOSInsufficient inventory. The renewal cannot be completed. Retry later.
Check the top-level code for PRODUCT_OOS. The PRODUCT_OOS response example is illustrative; the msg text may vary. This error response is separate from data.success in a successful HTTP response.

Renewal result#

This endpoint returns data.success (boolean), not a numeric data.status.
data.success = true: at least one renewal item succeeded; this includes partial renewal success.
data.success = false: none of the attempted renewal items succeeded. Check data.msg and the failure details. Validation and authorization failures can instead return an error response.
data.successList: successfully renewed items and their updated expiration times.
data.errorList: failed sub-order IDs, when available.
data.errProxies: failed proxy details, when available. Some failures have no proxy payload, so an empty errProxies array alone does not prove complete renewal success.
Inspect data.success, data.msg, data.successList, and data.errorList together. A successful HTTP response or top-level err = false does not by itself mean that renewal succeeded.

Related order status#

The order-query endpoints use: 0 = Idle (not activated), 1 = Activated, 2 = Expired, 3 = Deleted (soft-deleted). Orders in status 2 or 3 cannot be renewed and must be repurchased. Query the order after renewal to retrieve its current status and expiration details.

Response example provenance#

Examples were generated through local testing on 2026-09-15 using synthetic, nonfunctional test values for identifiers, proxy addresses and credentials. They illustrate the response format and are not production response captures. Amounts, stock and dates are illustrative, not live quotations or availability.

Request

Authorization
Bearer Token
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
or
Path Params

Responses

🟢200
application/json
Success
Bodyapplication/json

🟠400BadRequestError
🟠401UnauthorizedError
🟠400PRODUCT_OOS
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '/api/v1/service/purchase/ip//renew' \
--header 'Authorization: Bearer <token>'
Response Response Example
200 - Successful renewal — verified test data
Examples were generated through local testing on 2026-09-15 using synthetic, nonfunctional test values for identifiers, proxy addresses and credentials. They illustrate the response format and are not production response captures. Amounts, stock and dates are illustrative, not live quotations or availability. POST /api/v1/service/purchase/ip/22222222-2222-4222-8222-222222222222/renew with an empty JSON body. successList[].orderId is a legacy alias for subOrderId, not the parent order ID. expiry and expireAt contain the same updated expiration value. This endpoint returns success, not a numeric status.
{
    "data": {
        "success": true,
        "msg": "ISP order renewal completed.",
        "errProxies": [],
        "successList": [
            {
                "orderId": "11111111-1111-4111-8111-111111111111",
                "subOrderId": "11111111-1111-4111-8111-111111111111",
                "expiry": "2026-11-14T02:00:00.000Z",
                "expireAt": "2026-11-14T02:00:00.000Z",
                "proxies": [
                    {
                        "subOrderId": "11111111-1111-4111-8111-111111111111",
                        "productId": "product_example_us_001",
                        "proxy": "192.0.2.10:8000:exampleuser:ExamplePass001",
                        "expireAt": "2026-11-14T02:00:00.000Z"
                    },
                    {
                        "subOrderId": "11111111-1111-4111-8111-111111111111",
                        "productId": "product_example_us_001",
                        "proxy": "192.0.2.11:8000:exampleuser:ExamplePass001",
                        "expireAt": "2026-11-14T02:00:00.000Z"
                    }
                ]
            }
        ],
        "errorList": [],
        "paymentDetails": {
            "totalPrice": 6,
            "discount": 1
        }
    },
    "err": false,
    "msg": "SUCCESS",
    "code": 200
}
Modified at 2026-10-16 02:13:25
Previous
Get purchased IP order detail
Next
Get country list
Built with