简体中文

English

简体中文

English

显示模式

关于 使用量收费 ​

访问范围

需要多个访问范围—请参阅每个端点以了解访问范围要求。

需要访问受保护的客户数据。

该账单 API 提供了一组 RESTful 接口，用于管理应用程序账单信息，包括创建、取消、读取账单和上报使用费。该 API 旨在为Genstore平台上的商家订阅应用程序并使用应用程序等服务。

功能：

  1. 创建定期应用程序费用：允许商户定期创建应用程序订阅费用。
  2. 取消定期应用费用：允许商户取消应用程序订阅费用。
  3. 检索单笔费用：允许商户根据订阅费用ID查询费用信息。
  4. 创建使用量费用：允许商户按照使用量创建费用。

调用注意事项

在使用账单 API 时，请注意：

  1. 数据一致性：在创建使用量费用时，如果要避免重复创建，请保证每次请求的 extUniqueId 不一致。

使用场景

以下是账单 API 在实际应用中的几个场景，帮助开发者理解其具体的使用价值：

  • 创建定期应用程序费用：商家可以通过 API 为应用创建定期计费方案，支持按时间、按使用量以及时间与使用量结合的混合计费方式。
  • 取消定期应用费用：商家可以通过 API 接口取消店铺当前的定期订阅费用。
  • 检索单笔费用：商家可以通过 API 检索单个订阅信息，以便了解改订阅产生的完整信息。
  • 创建使用量费用：商户订阅了按使用量计费的应用后，可以通过 API 上报使用量，以生成相应的使用费用。

接口

POST /api/202412/recurring_application_charges/{chargeId}/usage_charges: 创建使用量费用

使用量费用 对象 ​

使用量费用的对象。

属性 ​

usageChargeobject
使用费实体类。
- 收起属性
idnumber
使用费的 ID。
descriptionstring
使用费的描述。
pricestring
使用费的价格。
createTimestring
创建使用费的日期和时间。
currencystring
使用费价格的货币。
balanceUsedstring
已使用的余额。
balanceRemainingstring
剩余余额。
riskLevelnumber
风险等级。
bash
{
  "usageCharge": {
    "balanceRemaining": "2",
    "riskLevel": "0",
    "createTime": "2013-06-27T08:48:27-04:00",
    "price": "10",
    "description": "Super Mega Plan 1000 emails",
    "currency": "USD",
    "id": "675931192",
    "balanceUsed": "11"
  }
}

POST 创建使用量费用 ​

商户订阅了按使用量计费的应用后，可通过此接口上报使用量，以生成相应的使用费用。

访问范围

需要以下任意访问权限: write_billing

接口

POST /api/202412/recurring_application_charges/{chargeId}/usage_charges 

请求参数

usageChargeobject
使用费实体类。
+ 展开属性
extUniqueIdstring
用于标识每次请求的唯一key。

响应数据

usageChargeobject
使用费实体类。
- 收起属性
idnumber
使用费的 ID。
descriptionstring
使用费的描述。
pricestring
使用费的价格。
createTimestring
创建使用费的日期和时间。
currencystring
使用费价格的货币。
balanceUsedstring
已使用的余额。
balanceRemainingstring
剩余余额。
riskLevelnumber
风险等级。
bash
curl -X POST \ 
https://{shop}.genmystore.com/api/202412/recurring_application_charges/{chargeId}/usage_charges" \ 
-H "X-Genstore-Access-Token: {access_token}" \ 
-H "Content-Type: application/json" \ 
-d '{
	"usageCharge":{
		"price":"10",
		"description":"Super Mega Plan 1000 emails"
	},
	"extUniqueId":"2435331231"
}'
json
HTTP/1.1 200 OK
{
  "usageCharge": {
    "balanceRemaining": "2",
    "riskLevel": "0",
    "createTime": "2013-06-27T08:48:27-04:00",
    "price": "10",
    "description": "Super Mega Plan 1000 emails",
    "currency": "USD",
    "id": "675931192",
    "balanceUsed": "11"
  }
}