OpenAPI Documentation
OpenAPI Documentation

List Static Proxy Renewal Orders

Returns a paginated list of static proxy renewal orders for the current caller identity.

API Information

Item Value
Method GET
Path /open-api/v1/static/renewal-orders
Authentication X-API-Key
Processing Synchronous

Query Parameters

Parameter Type Required Description
order_no string No Exact order number match; must not be an empty string
status string No PROCESSING, COMPLETED, or FAILED
create_time_start string No Inclusive lower bound for creation time, with Z or an explicit offset
create_time_end string No Inclusive upper bound for creation time, with Z or an explicit offset
page_no integer No Defaults to 1; must be at least 1
page_size integer No Defaults to 20; range: 1100

The start time must not be later than the end time.

Request Example

curl --request GET \
  --url 'https://api-test.puraroute.com/gin/open-api/v1/static/renewal-orders?status=PROCESSING&page_no=1&page_size=20' \
  --header 'Accept: application/json' \
  --header 'X-API-Key: <YOUR_API_KEY>'

Response Fields

data uses the pagination structure. Each element in list contains:

Field Type Nullable Description
order_no string No Renewal order number
status string No PROCESSING, COMPLETED, or FAILED
duration_days integer No Uniform renewal duration
total_quantity integer No Number of resources after deduplication
order_amount string No Order amount in USD
currency string No Settlement currency
create_time string No Creation time in GMT+8 ISO-8601 format
finish_time string Yes For COMPLETED, the time when all resources completed; for FAILED, the time when the first failed result appeared, which does not mean every resource has finished processing; null for PROCESSING

Successful Response Example

{
  "code": 0,
  "msg": "success",
  "data": {
    "list": [
      {
        "order_no": "PO1912345678901234567",
        "status": "PROCESSING",
        "duration_days": 30,
        "total_quantity": 2,
        "order_amount": "16.0000",
        "currency": "USD",
        "create_time": "2026-08-24T15:30:00.000+08:00",
        "finish_time": null
      }
    ],
    "total": 1,
    "page_no": 1,
    "page_size": 20
  },
  "next": null
}

Multiple resources in one renewal order may have different outcomes. You can stop polling when the order is COMPLETED. For a FAILED order, the list result alone does not show whether every resource has finished processing. Continue querying the order details until no item in resources has the PROCESSING status. Successfully renewed resources retain their new expiration times. Refunds are not automatic; contact customer support for manual handling. Query the details again after manual handling to get the latest result.

Possible Error Codes

code Description
400001 Authentication failed
400009 The status, time range, pagination, or another parameter does not meet the requirements
500000 System processing failed and the request was not completed

On this page