OpenAPI Documentation
OpenAPI Documentation

Get Static Proxy Renewal Order Details

Returns a static proxy renewal order and the latest renewal result for each resource by order number.

API Information

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

Path Parameters

Parameter Type Required Description
order_no string Yes Static proxy renewal order number; must not be an empty string

Query parameters are not accepted.

Request Example

curl --request GET \
  --url 'https://api-test.puraroute.com/gin/open-api/v1/static/renewal-orders/PO1912345678901234567' \
  --header 'Accept: application/json' \
  --header 'X-API-Key: <YOUR_API_KEY>'

Response Fields

The response contains all fields from a renewal-order list item, plus resources:

Field Type Description
resources array Resource-level results for this renewal

Each element in resources contains:

Field Type Nullable Description
resource_id string No Static proxy resource ID
status string No PROCESSING, COMPLETED, or FAILED
expire_time string No Current expiration time of the resource in GMT+8 ISO-8601 format
duration_days integer No Renewal duration for this request
finish_time string Yes Time when this resource completed or failed; null while processing

At the order level, finish_time is the time when all resources completed for a COMPLETED order. For a FAILED order, it is the time when the first failed result appeared and does not mean every resource has finished processing. It is null for a PROCESSING order.

Successful Response Example

{
  "code": 0,
  "msg": "success",
  "data": {
    "order_no": "PO1912345678901234567",
    "status": "COMPLETED",
    "duration_days": 30,
    "total_quantity": 2,
    "order_amount": "16.0000",
    "currency": "USD",
    "create_time": "2026-08-24T15:30:00.000+08:00",
    "finish_time": "2026-08-24T15:35:00.000+08:00",
    "resources": [
      {
        "resource_id": "1912345678901234568",
        "status": "COMPLETED",
        "expire_time": "2026-10-23T15:30:00.000+08:00",
        "duration_days": 30,
        "finish_time": "2026-08-24T15:34:30.000+08:00"
      },
      {
        "resource_id": "1912345678901234569",
        "status": "COMPLETED",
        "expire_time": "2026-10-23T15:30:00.000+08:00",
        "duration_days": 30,
        "finish_time": "2026-08-24T15:35:00.000+08:00"
      }
    ]
  },
  "next": null
}

Polling Stop Conditions

  • If the order is PROCESSING, continue querying.
  • If the order is COMPLETED, all resources have completed and automatic polling can stop.
  • If the order is FAILED, not every resource has necessarily finished processing. Continue querying while any item in resources is still PROCESSING. After all resources leave PROCESSING, stop automatic polling and contact customer support.

Multiple resources in one order may have different outcomes. Even if the order is FAILED, the new expire_time of each COMPLETED resource is retained. A FAILED order is not refunded automatically. Query this endpoint again after manual handling to obtain the latest result.

A callback is sent only once, when the order first enters COMPLETED or FAILED. Failed delivery is not retried, and no additional callback is sent after the remaining resources finish processing. Whether or not a callback is received, use the latest response from this endpoint as the source of truth.

Possible Error Codes

code Description
300001 The order does not exist or is not accessible
400001 Authentication failed
400009 The path or request parameters do not meet the requirements
500000 System processing failed and the request was not completed

On this page