简体中文

English

简体中文

English

显示模式

关于 订阅收费 ​

访问范围

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

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

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

功能：

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

调用注意事项

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

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

使用场景

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

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

接口

EVENT appSubscriptions/update: 应用程序订阅变更

订阅收费 对象 ​

应用订阅收费对象。

属性 ​

recurringApplicationChargeobject
订阅实体类。
- 收起属性
idnumber
定期收费的 ID。
namestring
定期收费的名字。
pricestring
定期收费的价格。
billingTimestring
向客户收费的日期和时间。
statusstring
定期收款的状态。枚举值：
* pending - 待处理;
* active - 活跃;
* declined - 拒绝;
* expired - 已过期;
* frozen - 冻结;
* cancelled - 已取消;
createTimestring
创建定期应用程序费用的日期和时间。
updateTimestring
上次更新定期应用程序费用的日期和时间。
activatedTimestring
客户激活定期应用程序费用的日期和时间。
returnUrlstring
商家在接受收款后被重定向的 URL。
testboolean
应用程序费用是否为测试交易。
cancelledTimestring
商家取消其定期申请费用的日期和时间。
trialDaysnumber
客户有资格免费试用的天数。
trialEndsTimestring
免费试用结束的日期和时间。
confirmationUrlstring
商家接受或拒绝定期应用程序费用的 URL。
currencystring
定期应用程序费用价格的货币。
bash
{
  "recurringApplicationCharge": {
    "trialEndsTime": "2025-04-01T15:46:46-04:00",
    "trialDays": "5",
    "test": "false",
    "confirmationUrl": "https://jsmith.blaze.com/admin/charges/755357713/1029266966/RecurringApplicationCharge/confirm_recurring_application_charge?signature=BAh7BzoHaWRpBBZeWT06EmF1dG9fYWN0aXZhdGVU--98ef575ea1fff24621e47eaa65e42758f13a3ae5",
    "billingTime": "2025-04-01T15:46:46-04:00",
    "updateTime": "2025-04-01T15:46:46-04:00",
    "createTime": "2025-04-01T15:46:46-04:00",
    "activatedTime": "2025-04-01T15:46:46-04:00",
    "price": "20.0",
    "cancelledTime": "2025-04-01T15:46:46-04:00",
    "name": "Super Duper Plan",
    "currency": "USD",
    "id": "1029266966",
    "returnUrl": "http://super-duper.blaze.com/",
    "status": "pending"
  }
}

EVENT 应用程序订阅变更 ​

订阅应用程序发生变更的消息，主要包括待处理、活跃、拒绝、已过期、冻结、已取消

访问范围

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

消息

EVENT appSubscriptions/update 

消息数据

appSubscriptionobject
订阅消息体。
- 收起属性
createTimestring
创建时间。
currencystring
币种。
idstring
定期应用费用的 ID。
namestring
定期应用费用的名称。
shopIdstring
店铺唯一标识符。
statusstring
订阅状态。枚举值：
* pending - 待处理;
* active - 活跃;
* declined - 拒绝;
* expired - 已过期;
* frozen - 冻结;
* cancelled - 已取消;
updateTimestring
更新时间。
cappedAmountstring
基于使用量计费时可向客户收取的费用上限
pricestring
周期性应用费用的价格。
intervalstring
订阅周期。
json
{
  "appSubscription": {
    "cappedAmount": "20.0",
    "createTime": "2025-04-22T11:08:24.284+0800",
    "price": "10.0",
    "name": "Free install",
    "currency": "USD",
    "updateTime": "2025-04-22T11:08:25.412+0800",
    "interval": "MONTH",
    "id": "15300",
    "shopId": "4022082659398",
    "status": "cancelled"
  }
}