订购后付费资源套餐 CreatePostPaidOrder--云游戏-火山引擎

文档中心

立即注册

导航

订购后付费资源套餐 CreatePostPaidOrder

最近更新时间：2025.01.20 15:42:50首次发布时间：2024.04.19 13:53:05

本接口支持订购手游业务下的后付费资源套餐。

使用说明

资源套餐订购成功后，实例资源数量默认为 0。需通过调用 UpdateAppliedResource 接口，修改已订购资源套餐的实例数量。
资源订购成功后，需及时支付账单、避免账号欠费导致服务关停。详细信息，参考计费说明文档。

请求说明

请求方式：POST
请求地址：https://open.volcengineapi.com?Action=CreatePostPaidOrder&Version=2023-03-18

请求参数

下表仅列出了接口特有的请求参数和部分公共参数。完整的公共参数列表，参考公共请求参数。

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`CreatePostPaidOrder`	接口名称。当前 API 的名称为 `CreatePostPaidOrder`。
Version	String	是	`2023-03-18`	接口版本。当前 API 的版本为 `2023-03-18`。

Body

参数类型是否必选示例值描述

ProductId String 是 1493071161301xxxxxx 云游戏业务 ID，您可在控制台 > 云游戏手游 > 业务管理或通过调用 GetProductList 接口获取。

PreorderList Array of PreorderList 是 - 资源订购配置单列表

参数	类型	是否必选	示例值	描述
ProductId	String	是	`1493071161301xxxxxx`	云游戏业务 ID，您可在控制台 > 云游戏手游 > 业务管理或通过调用 GetProductList 接口获取。
PreorderList	Array of PreorderList	是	`-`	资源订购配置单列表
OneStep	Boolean	否	`false`	是否开启一键下单订购资源，取值如下所示： `true`：订购资源后直接支付订单 `false`：（默认）订购资源后获取订单号，再通过订单号支付

OneStep

Boolean

否

false

是否开启一键下单订购资源，取值如下所示：

true：订购资源后直接支付订单
false：（默认）订购资源后获取订单号，再通过订单号支付

PreorderList

参数类型是否必选示例值描述

参数	类型	是否必选	示例值	描述
ConfigurationCode	Array of String	否	`General_Postpaid`	实例资源套餐 ID，取值如下所示（如业务下已订购某个资源套餐、则无需重复订购）： `Standard_Postpaid`：基础型 `General_Postpaid`：通用型 `Enhanced_Postpaid`：加强型 `Advanced_Postpaid`：旗舰型

ConfigurationCode

Array of String

否

General_Postpaid

实例资源套餐 ID，取值如下所示（如业务下已订购某个资源套餐、则无需重复订购）：

Standard_Postpaid：基础型
General_Postpaid：通用型
Enhanced_Postpaid：加强型
Advanced_Postpaid：旗舰型

返回参数

下表仅列出本接口特有的返回参数。更多信息请见返回结构。

参数类型示例值描述

参数	类型	示例值	描述
Result	Array of String	`success`	资源订购结果，取值如下所示：当指定 `OneStep=false`，返回资源订单号列表（通过拼接订单号可进入付款页面）当指定 `OneStep=true`，资源直接订购成功

Result

Array of String

success

资源订购结果，取值如下所示：

当指定 OneStep=false，返回资源订单号列表（通过拼接订单号可进入付款页面）
当指定 OneStep=true，资源直接订购成功

请求示例

POST https://open.volcengineapi.com?Action=CreatePostPaidOrder&Version=2023-03-18
{
    "ProductId": "1493071161301xxxxxx",
    "PreorderList": [
        {
            "ConfigurationCode": [
                "General_Postpaid"
            ]
        }
    ],
    "OneStep": true
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202306041104200100100232280022D31",
        "Action": "CreatePostPaidOrder",
        "Version": "2023-03-18",
        "Service": "veGame",
        "Region": "cn-north-1"
    },
    "Result": {
        "Result": [
            "success"
        ]
    }
}

错误码

您可访问公共错误码，获取更多错误码信息。