订单

诸如product_id、location_id等选项可以使用产品端点进行检索。

产品

获取多个订单

GET /orders

查询参数

名称
类型
描述
可用选项

product_id

整型

产品ID

page

整型

页数

per_page

整型

每页获取的订单数

location_id

整型

位置ID

status

字符串

订单状态

note_search

字符串

要搜索的订单备注字段中的短语

order_ids

数组

目标订单的ID

sort_by

字符串

要排序的列。与订单一起使用时为必填项

order

字符串

对订单分类。与sort_by一起使用时为必填项

statuses

数组

订单状态。必须仅包含可用选项中的值。

status_is_expiring_soon

布尔值

订单是否即将到期

order_billing_type

字符串

订单计费类型

响应案例:

响应示例:

获取订单

GET /orders/{order_id}

响应案例:

响应示例:

计算价格

GET /orders/calculate-pricing

查询参数

名称
类型
描述
可用选项

product_id

整型

产品ID

product_plan_id

整型

产品套餐ID

product_location_id

整型

产品地理位置ID

quantity

整型

代理数量

coupon_code

字符串

优惠码

order_id

整型

订单编号

order_billing_type

字符串

订单计费类型

product_question_answers

数组

产品问题答案

响应案例:

响应示例:

创建订单

POST /orders

正文参数

名称
类型
描述

product_id

整型

产品ID

product_plan_id

整型

产品套餐ID

product_location_id

整型

产品地理位置ID

quantity

整型

代理数量

coupon_code

字符串

优惠码

auto_extend

布尔值

订单是否会自动续期 預設值為 false

product_question_answers

数组

问题解答

card_id

整型

卡号。如果订单通过卡支付,则必须提供卡号,否则会被视为用余额购买

selection

数组

您可以使用 selection.locations字段提供多个位置及其数量。当您使用此功能时,无需在请求正文中指定product_plan_idquantity量作为顶层参数。

响应案例:

响应示例:

续期订单

POST /orders/{order_id}/extend

正文参数

名称
类型
描述

product_plan_id

整型

产品套餐ID

card_id

整型

卡号。如果订单通过卡支付,则必须提供卡号,否则会被视为用余额购买

proxies

数组

可选的IP地址扩展列表。若省略或为空,则扩展该订单对应的所有代理。

响应案例:

响应示例:

切换订单自动续费

POST /orders/toggle-auto-extend

查询参数

名称
类型
描述
可用选项

order_id

整型

订单ID

is_enabled

布尔值

是否应启用或禁用自动续费

product_plan_id

整型

订单的产品方案ID。此参数为非必填项,若为空,则默认使用订单当前的产品ID

payment_type

字符串

续费使用的支付方式。若is_enabled为否,则此参数为非必填项

card_id

整型

用于支付续费的银行卡ID。若payment_type为余额,则此参数为非必填项

响应案例:

响应示例:

Last updated