创建未来费率方案

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

简介

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

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

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

开发者会收到有关修订后的费率方案的通知。接受原始费率方案的开发者将自动注册该修订版本(但可以选择拒绝该修订版本)。

您可以使用管理界面或 Monetize 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 (Private Cloud)

如需使用传统版 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