Create a Static Proxy Purchase Order

POST /open-api/v1/static/purchase-orders

Base URL: https://api.ipfbs.com/gin.

Authentication

Send your key in the X-API-Key request header.

JSON request body

Field	Type	Required	Constraints	Meaning
request_no	string	Yes	minLength: 1; maxLength: 64; pattern: ^[A-Za-z0-9_-]{1,64}$	Caller request number for duplicate protection.
static_type	string	Yes	enum: ISP, ISP_NATIVE, ISP_CARRIER_NATIVE	Static proxy product type.
duration_days	integer	Yes	format: int32; minimum: 1	Duration in days. Use a positive integer supported by the active price catalog.
regions	object[]	Yes	—	One or more purchase regions; each region appears once.
regions[].region_code	string	Yes	—	Region code returned by the regions endpoint.
regions[].quantity	integer	Yes	format: int32; minimum: 1; maximum: 300	Quantity for this region or the whole order, as indicated by the field path.
callback_url	string	No	maxLength: 2048	Optional terminal status callback URL, subject to server validation.

Request example

curl --request POST \
  --url 'https://api.ipfbs.com/gin/open-api/v1/static/purchase-orders' \
  --header 'Accept: application/json' \
  --header 'X-API-Key: <YOUR_API_KEY>' \
  --header 'Content-Type: application/json' \
  --data '{
  "request_no": "static_buy_20260824_001",
  "static_type": "ISP",
  "duration_days": 30,
  "regions": [
    {
      "region_code": "US_CA",
      "quantity": 2
    }
  ]
}'

Success response data

Responses use code, msg, data, and next. HTTP 200 can also contain a nonzero business error code; check code first.

Field	Type	Required	Constraints	Meaning
data.order_no	string	No	—	Order no.
data.status	string	No	enum: UNFULFILLED, PROCESSING	Current status of this resource or order.
data.static_type	string	No	enum: ISP, ISP_NATIVE, ISP_CARRIER_NATIVE	Static proxy product type.
data.duration_days	integer	No	format: int32; minimum: 1	Duration in days. Use a positive integer supported by the active price catalog.
data.quantity	integer	No	format: int32; minimum: 1	Quantity for this region or the whole order, as indicated by the field path.
data.order_amount	string	No	—	Order or quote amount as a decimal string.
data.currency	string	No	—	Currency.
data.create_time	string	No	format: date-time	Create time.
data.regions	object[]	No	—	One or more purchase regions; each region appears once.
data.regions[].region_code	string	No	—	Region code returned by the regions endpoint.
data.regions[].quantity	integer	No	format: int32	Quantity for this region or the whole order, as indicated by the field path.
data.regions[].order_amount	string	No	—	Order or quote amount as a decimal string.

Endpoint notes

The wallet is charged when the order is accepted; fulfillment is asynchronous. A successful creation response does not mean the proxy resources are ready. The purchase duration is a positive integer and must have an active price for the selected type and region.

Related conventions

Request conventions · Response structure · Error codes · API reference index