创建未来费率方案

您正在查看 Apigee Edge 文档。
转到 Apigee X 文档
信息

简介

现有价格方案发布后,您只能更改该价格方案的结束日期。 不过,您可以创建包含已更改的属性(例如已更改的费率方案费率)的新版方案。您可以将修订版本设置为在未来某个日期生效。原始费率方案会在修订版本生效时结束。

例如,假设您创建了一个将于 2019 年 12 月 31 日到期的标准费率方案,并希望将其替换为 2020 年 1 月 1 日生效的另一个方案。为此,您需要创建一个未来的费率方案,并将其设置为在 2020 年 1 月 1 日生效。

如果当前费率方案未设置结束日期,您可以将现有费率方案替换为最早从今天开始的未来费率方案。您需要让当前的费率方案到期,如让已发布的费率方案到期中所述。

系统会通知开发者价格方案已修改。接受原始费率方案的开发者会自动注册修订版本(但可以选择拒绝修订版本)。

如以下部分所述,您可以使用管理界面或 monetization API 创建未来的费率方案。

使用界面创建未来的费率方案

按照下文所述创建未来的费率方案。

Edge

如需使用 Edge 界面创建在今天之后的某个时间开始的未来价格方案版本,请执行以下步骤。

  1. “费率方案”页面上,将光标悬停在要创建未来费率方案的费率方案所对应的行中。
    此费率方案必须设有结束日期。
  2. 点击 + 未来
  3. 未来费率方案部分,选择以下任一选项:
    • 在新的生效日期重新开始整个合同期:未来费率方案将于生效日期生效。未来费率方案的续订期限与当前费率方案相同。
    • 从生效日期起,从新合约中扣减先前合同的用时:未来费率方案将于生效日期生效。使用当前费率方案所花的时间会从未来费率方案的续订期限中扣除。这意味着,如果开发者使用当前方案 3 个月,而续订期缩短了 3 个月,
  4. 在顶部面板中配置以下字段:
    注意:其他字段为只读字段。
    字段 说明 默认 必需
    价格方案名称

    您的价格方案的名称。

    注意:该名称无需与原始费率方案的名称一致。

    现有方案名称
    开始日期 费率方案的生效日期。输入开始日期或使用日历选择日期。 今天
    结束日期 价格方案的结束日期。若要指定结束日期,请启用包含结束日期切换开关,然后输入结束日期或使用日历选择日期。

    注意:该费率方案的有效期会持续到指定日期的当天结束。例如,如果您想在 2018 年 12 月 1 日过期价格方案,则应将 endDate 值设置为 2018-11-30。在这种情况下,价格方案将于 2018 年 11 月 30 日结束时失效;2018 年 12 月 1 日的所有请求都将被屏蔽。

    对门户可见 设置价格方案是公开还是不公开。请参阅公开价格方案与不公开价格方案 已启用
  5. 配置价格方案的费用。请参阅配置费用
    注意:不适用于可调整的通知计划。
  6. 如果您选择的产品套装包含多个 API 产品,请在专用或通用费率方案部分中设置以下偏好设置:
    注意:此步骤不适用于可调整的通知方案。
    字段 说明 默认
    分别配置每个产品 用于指定是否为每个 API 产品配置单独的费率方案的标志。 已停用
    单独配置每个产品的免费增值优惠 用于指定是否为每个 API 产品配置免费增值方案的标志。 已停用
    选择产品 如果您启用了其中一个或两个标记,则必须从下拉列表中选择每个产品,并配置其价格方案详细信息。

    注意:请务必配置商品套装中的所有商品。

    不适用
  7. 根据所选的价格方案类型配置价格方案详情:
  8. 点击下列选项之一:
    按钮 说明
    更新草稿 将该价格方案保存为草稿。

    在您发布此价格方案之前,应用开发者不会看到此价格方案。您可以修改草稿费率方案中的任何字段。

    发布草稿 发布方案。

    注意:发布价格方案后,您只能修改尚未设置的结束日期。您无法删除已发布的价格方案,但可以使该价格方案失效,然后将其替换为未来的价格方案,如让已发布的价格方案到期中所述。

传统 Edge(私有云)

如需使用传统版 Edge 界面创建从今天之后的某个时间开始的未来价格方案版本,请执行以下步骤。

  1. 在套餐目录中,点击要替换的费率方案对应的“草稿/未来”列中的 + 未来

    系统随即会打开未来的“费率方案”窗口。

    未来费率方案时段和当前费率方案时段之间的主要区别是增加了“现有订阅者”部分。

  2. 与任何价格方案一样:
    • 在“费率方案名称”字段中输入方案的名称。此名称不必与原始费率方案的名称一致。
    • 为价格方案配置费用(可选)。
    • 根据所选的价格方案类型配置价格方案详情:
    • 指定未来方案的生效日期(请参阅发布费率方案)和结束日期(如果您不想让未来费率方案在特定日期结束,也可以选择“无结束日期”)。如果为当前方案设置了结束日期,则未来方案的生效日期应晚于当前方案的结束日期。
  3. 在“现有订阅者”部分,选择以下任一选项:
    • 在新的生效日期重新开始整个合同期。未来费率方案将于生效日期生效。未来费率方案的续订期限与当前费率方案相同。
    • 自生效日期起,从新周期开始扣减先前合同的用时。未来费率方案将于生效日期生效。使用当前费率方案所花的时间会从未来费率方案的续订期限中扣除。这意味着,如果开发者使用当前方案 3 个月,而续订期缩短了 3 个月,
  4. 在“生效日期”字段中,输入一个晚于现有费率方案的结束日期的开始日期。

使用 API 创建未来的费率方案

您可以使用 API 向 /organizations/{org_name}/monetization-packages/{package_id}/rate-plans/{plan_Id}/revision 发出 POST 请求,以创建未来费率方案。

其中:

  • {org_id} 是组织的名称。
  • {package_id} 是 API 软件包的标识。
  • {plan_Id} 是费率方案的标识。
创建修订版本时,必须在请求正文中指定以下属性:
  • parentRatePlan 用于指定原始费率方案的 ID。
  • startDate 指定新方案的生效日期。

未来费率方案的名称不得与原始方案的名称一致。此外,该日期在您的所有费率方案中必须是唯一的。如果您希望保留为开发者记录的原始开始日期,请将 keepOriginalStartDate 标志设置为 true。此标志默认为 false

如需详细了解配置设置,请参阅 价格方案的配置设置

例如,以下请求会创建未来的费率方案:

$ curl -H "Content-Type:application/json" -X POST -d \
'{ 
     "parentRatePlan": {
       "id": "monetization_package_flat_rate_card_plan_1379513833409"
     },
     "name": "Flat rate card plan",
     "developer":null,
     "developerCategory":null,
     "advance": "false",
     "currency": {
      "id" : "usd"
     },     
     "description": "Flat rate card plan",
     "displayName" : "Flat rate card plan",
     "frequencyDuration": "30",
     "frequencyDurationType": "DAY",
     "earlyTerminationFee": "10",     
     "monetizationPackage": {
      "id": "location"
     },
     "organization": {
      "id": "{org_name}"
     },
     "paymentDueDays": "30",
     "prorate": "false",
     "published": "true",
     "ratePlanDetails": [
     {
      "currency": {
       "id" : "usd"
      },
      "paymentDueDays": "30",      
      "meteringType": "UNIT",
      "organization": {
       "id": "myorg"
      },
      "ratePlanRates": [
       {
        "type": "RATECARD",
        "rate": "0.05",
        "startUnit": "0"       
       }      
      ],     
     "ratingParameter": "VOLUME",
     "type": "RATECARD"
     }],
     "recurringStartUnit": 1,
     "recurringType": "CALENDAR",
     "recurringFee": "10",
     "setUpFee": "10",
     "startDate": "2014-01-01 00:00:00",
     "type": "STANDARD"
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/location/rate-plans/monetization_package_flat_rate_card_plan_1379513833409/revision" \
-u email:password