配置价目表方案

您正在查看 Apigee Edge 文档。
前往 Apigee X 文档
信息

简介

在费率卡方案中,系统会针对每笔交易向开发者收费。对于此类方案,您需要提供更多详细信息,例如充电模式和充电模式的价格。

您可以选择为个别产品(而非 API 软件包)指定免费增强型方案,但只能为产品专用方案执行此操作。

何时收取周期性费用以及何时重置套餐方案?

费率方案可以包括周期性费用和 API 套餐(按量分级方案和套餐方案),这两者都涉及收取费用和套餐方案重置为零的特定时间。下表介绍了周期性费用的收取时间以及套装计数的重置时间。如果开发者应用因达到特定事务限制而被禁止进行进一步的 API 调用,此时 API 调用计数会重置为零,并且应用可以开始再次进行调用。

如果方案具有以下特征, ...这种情况发生了
  • 设置为的非零周期性费用
  • 按量分级或套餐方案

周期性费用和套装方案会在每月第一天重置(默认设置)。

对于特定日期的每月周期性复发,请使用管理 API 创建费率方案,并使用 RecurringStartUnit 属性指明日期,如使用 API 创建费率方案中所述。

  • 周期性费用设为 Week(周),且不为零
  • 按卷或套装方案
在开发者费率方案开始日期后,系统会每 7 天重置一次周期性费用和套餐方案。
  • 周期性费用设为 Day(天),且不为零
  • 按卷或套装方案
在开发者的费率方案开始日期之后,系统会每 X 天重置一次周期性费用和套餐方案。
  • 无经常性费用(或零美元)
  • 按量分级或套餐方案

系统会根据费率卡上定义的汇总依据来重置套餐方案。例如,如果开发者在每月 19 号启动一个费率方案,而汇总基础为每 1 个月,则系统会在每个月的 19 号重置套装使用情况。

请注意,日期可能并不总是相同。例如,如果费率方案从 12 月 31 日开始,则重置日期会变为平年 2 月的第 28 天,因为 2 月只有 28 天。此后,28 号仍然是重置日期。

使用界面配置费率卡方案

配置价目表方案,如下所述。

Edge

如需配置价目表方案,请在创建修改价目表方案时,选择价目表价目表和收益分成价目表方案类型,然后在价目表部分选择以下任一收费模式:

充电模式 说明
固定费率 按固定费率向开发者收取每笔交易的费用。
按卷级分组 系统会根据交易量向开发者收取可变费率。
套装 对于每组交易,开发者需预先支付固定金额的费用。无论套装是否全部使用,开发者都需要支付固定金额。

注意:如果您选择“费率卡”和“收益分成”,则此选项不可用。

然后,根据所选的充电模式配置以下信息。

充电模式 字段 说明
所有 计算频率 计算交易量(或与自定义属性相关的量)所涵盖的时间段。选择相应月数(1-24 个月)。
固定费率 固定费率 每笔交易收取的费率。输入一个小数(最多可输入四位小数)。

注意:您可以使用 API(而非界面)配置可为收费费率指定的小数位数。如需了解详情,请参阅配置费率方案费率的小数位数

例如,如果您输入 0.10,且币种为美元,则系统会按每笔交易向开发者收取 0.10 美元(如果是基于自定义属性,例如交易中传输的字节数,则系统会按传输指定字节数向开发者收取 0.10 美元)。

按卷级分组 音量分段 适用于按交易量段(或基于客户属性的交易量)收费的模型的一个或多个交易量范围(每个范围都是一个“交易量段”)。您可以为每个音量段分配费率。此费率适用于相应交易量段中的所有交易。指定第一个频段的上限,例如,最高为 1000(下限预设为大于 0)。

点击 + 新建以添加其他频段。

将最后一个频段的上限留空,表示此级别以上的所有交易。

注意:您可以使用 API(而非界面)配置可为收费费率指定的小数位数。如需了解详情,请参阅配置费率方案费率的小数位数

例如,如果您在“音量段”部分中指定了两个音量段(大于 0-1000 和 1000 及以上),则可以为大于 0-1000 音量段输入 0.15,为 1000 及以上音量段输入 0.10。如果所选币种为美元,那么前 1000 笔交易的费率为 0.15 美元(对于每笔交易),超过 1000 笔交易的费率为 0.10 美元。

软件包 API 软件包价格 软件包中的交易数量(或与自定义属性相关的数量,例如软件包中传输的字节总数)。您可以为每个套装指定价格。此价格适用于整个套装。指定第一个 bundle 的上限,例如,最高为 1000(下限设为大于 0)。

点击 + 新建以添加其他套装。除非您想针对最后一个软件包中的无限交易向开发者收取固定金额,否则必须为最后一个软件包指定上限。

注意:您可以使用 API(而非界面)配置可为收费费率指定的小数位数。如需了解详情,请参阅配置费率方案费率的小数位数

例如,如果您在“文件包大小”部分指定了两个文件包(大于 0 且小于等于 1000 的文件包,以及大于 1000 且小于等于 2000 的文件包),则可以为大于 0 且小于等于 1000 的文件包输入 50,为大于 1000 且小于等于 2000 的文件包输入 40。如果所选货币是美元,那么第一个套装的价格为 50 美元,第二个套装的价格为 40 美元。无论开发者在套装中使用了多少笔交易,系统都会向其收取适用的套装价格(也就是说,只要套装中的首笔交易完成,系统就会向开发者收取套装价格)。

如果您为 API 产品定义了自定义属性,则可以配置自定义评分参数,以便根据每笔交易中的自定义属性向应用开发者收费。例如,如果您设置了按每笔交易向开发者收费的方案,则可以根据自定义属性(例如后端传输的字节数,该数值可能会因交易而异)设置该方案的费率。

在这种情况下,请选择使用自定义评分参数,然后从下拉列表中选择自定义属性。如需了解详情,请参阅使用自定义属性配置费率方案

传统边缘(私有云)

如需使用 Classic Edge 界面配置费率卡方案,请执行以下操作:

  1. 按照相应步骤创建费率方案
  2. 在“费率方案类型”下拉菜单中,选择费率卡配置收入模型
  3. 如果所选 API 软件包包含多个 API 产品,请选择以下选项之一:

    注意:如果 API 软件包包含单个 API 产品,则可以跳过此步骤。

    • 产品专用方案,用于为每个 API 产品单独配置费率方案详情。
    • 适用于所有产品的通用方案,用于为所有 API 产品配置费率方案详细信息。
  4. 点击通用费率方案或每个 API 产品专用费率方案的费率卡

    注意:配置特定于 API 产品的方案时,您需要为每个 API 产品单独配置费率卡方案。

    系统随即会打开“费率卡”窗口。

  5. 为 API 产品设置免费增强型应用方案。免费增强型方案可让开发者在一定时间内或根据使用量免费使用 API 产品。

    请输入以下信息:

    字段 说明
    免费增值产品?

    免费试用期的时长。选择以下任一单选按钮:

    • 按数量。免费试用期取决于“数量”字段中指定的数量。
    • 按时长。费用周期基于“Freemium 时长”字段中指定的时间间隔。
    • 以先到者为准。当“数量”字段中的数量或“免费试用期时长”字段中的时间间隔用尽时(以先达到者为准),免费试用期即告结束。
    • 不可以。这不是免费增强型方案。这是默认值。
    免费增值应用的下载量

    开发者无需支付费用的交易量(或与交易记录政策中记录的自定义属性相关的交易量)。系统会针对 API 产品衡量此指标。输入卷号,例如 5000。这意味着,开发者启用此方案后,前 5,000 笔交易(或自定义属性相关项的前 5,000 次使用)不会产生费用。只有在“是否为免费增强型应用?”字段中选择“按数量”或“以先到者为准”时,此字段才会启用。

    免费增值时长

    开发者无需付费的时间间隔。输入一个数字,然后选择一个时间段,例如 1 个月。这意味着开发者无需支付 1 个月的费用。只有在“免费增强型应用?”字段中选择“按时长”或“以先到者为准”时,此字段才会启用。

  6. 选择以下充电模式之一:
    • 固定费率。在此模式下,系统会按固定费率向开发者收取每次交易费用。
    • 带音量条带。在此模式下,系统会根据交易量向开发者收取可变费率。
    • 套装。在此模式下,系统会针对每组交易向开发者收取一笔固定金额(预付费)。无论套装是否全部使用,开发者都需要支付设定的金额。

    对于固定费率模式:在“Generic Rate Card”(通用价目表)窗口的“Pricing”(价格)部分输入以下信息:

    字段 说明
    运营商(或组织)

    您的组织的名称。此字段使用组织付款资料中的“运营商”(或“组织”)字段值进行预设。

    国家/地区

    贵组织的运营国家/地区。此字段使用组织付款资料中的“国家/地区”字段值进行预设。

    统一费率

    对每笔交易收取的费率。输入一个小数(最多可输入四位小数)。

    注意:您可以使用 API(而非界面)配置可为收费费率指定的小数位数。如需了解详情,请参阅配置费率方案费率的小数位数

    例如,如果您输入 0.10,且币种为美元,则系统会按每笔交易向开发者收取 0.10 美元(如果是基于自定义属性,例如交易中传输的字节数,则系统会按传输指定字节数向开发者收取 0.10 美元)。

    对于卷带式模型:“通用价目表”窗口会显示其他字段,您可以使用这些字段来指定汇总依据以及指定“量带”(即您可以应用不同费率的交易量范围)。

    此类方案通常旨在通过为更高的转化量段提供折扣费率,鼓励开发者提高转化量。

    在“通用费率卡”窗口中输入以下信息:

    字段 说明
    汇总基础

    交易量(或与自定义属性相关的交易量)的汇总时间段。汇总的交易量用于确定交易量段以及要应用于每笔交易的费率。选择月份数(1-12 个月)。

    如需详细了解套装何时重置,请参阅何时收取周期性费用以及何时重置套装方案?

    音量条

    一个或多个交易量(或基于客户属性的)范围(每个范围是一个“量带”)。可以为每个音量频段分配一个费率(您可以在“定价”部分的“音量频段”字段中设置此费率)。此费率适用于相应交易量段中的所有交易。指定第一个频段的上限,例如上限为 1000(下限预设为大于 0)。点击 + 可添加第二个频段,例如,介于 1000 到 2000 之间。点击“+”以添加更多频段。您可以将最后一个频段的上限留空,以表示高于此级别的所有交易。

    价格
    运营商(或组织)

    您的组织的名称。此字段使用“组织付款资料”中的“运营商”(或“组织”)字段值进行预设。

    国家/地区

    贵组织的运营国家/地区。此字段使用组织付款资料中的“国家/地区”字段值进行预设。

    币种

    贵组织使用的“基本”货币或记账货币。此字段使用“组织付款资料”中的“币种”字段值进行预设,但您可以在此处进行更改。

    音量条

    音量频段的速率。您可以为每个音量段指定一个费率。为每个频段输入一个小数(最多四位小数)。

    注意:您可以使用 API(而非界面)配置可为音量等级比率指定的小数位数。如需了解详情,请参阅配置费率方案费率的小数位数

    例如,如果您在“音量频段”部分指定两个音量频段(>0-1000 以及 1000 及以上),则可以为 >0-1000 的音量频段输入 0.15,为 1000 及以上的音量频段输入 0.10。如果所选币种为美元,前 1,000 笔交易的费率为每笔交易 0.15 美元,超过 1,000 笔交易的费率为每笔交易 0.10 美元。

    对于捆绑型模式:通用费率卡窗口会显示其他字段,您可以使用这些字段指定汇总依据(开发者可以使用这组交易的时间段),以及指定与软件包相关的信息(例如软件包的大小)。

    在“通用费率卡”窗口中输入以下信息:

    字段 说明
    汇总依据

    开发者可以使用交易捆绑包(或使用基于自定义属性的捆绑包)的时长。选择相应月数(1-12 个月)。此期限过后,方案将到期,开发者必须重新购买方案(和套餐)。

    如需详细了解套餐的重置时间,请参阅何时收取周期性费用并重置套餐方案?

    套装大小

    捆绑包中的事务数量(或与自定义属性相关的数字,例如捆绑包中传输的总字节数)。您可以为每个套装分配价格(您可以在“价格”部分的“套装大小”字段中设置此价格)。此价格适用于整个套装。指定第一个软件包的上限,例如上限为 1000(下限预设为大于 0)。点击“+”以添加第二个文件包,例如大于 1000 且不超过 2000。点击 + 可添加更多内容集。您必须为最后一个软件包指定上限,除非您想针对最后一个软件包中的无限交易向开发者收取固定金额。

    价格
    运营商(或组织)

    您的组织的名称。此字段使用“组织付款资料”中的“运营商”(或“组织”)字段值进行预设。

    国家/地区

    贵组织的运营国家/地区。此字段使用组织付款资料中的“国家/地区”字段值进行预设。

    币种

    贵组织使用的“基准”或会计货币。此字段是使用组织资料中的“货币”字段值预设的,但可以在此处更改。

    套装大小(价格)

    套装的价格。您可以为每个套装指定价格。输入一个十进制数(最多小数点后四位)。

    注意:您可以使用 API(而非界面)配置可为套装费率指定的小数位数。如需了解详情,请参阅配置费率方案费率的小数位数

    例如,如果您在“文件包大小”部分指定了两个文件包(大于 0 且不超过 1,000 的文件包,以及大于 1,000 且不超过 2,000 的文件包),则可以为大于 0 且不超过 1,000 的文件包输入 50,为大于 1,000 且不超过 2,000 的文件包输入 40。如果所选币种为美元,则第一个套装的价格为 50 美元,第二个套装的价格为 40 美元。开发者需按适用的软件包价格付费,而不考虑他们在软件包中使用了多少笔交易(也就是说,开发者会在软件包中的第一笔交易完成后立即按软件包价格付费)。

  7. 点击应用并关闭以保存费率卡详细信息,然后返回“标准费率方案”窗口。
  8. 对于 API 产品专用的费率方案,可根据需要为其他 API 产品配置费率方案详细信息。

使用 API 配置费率卡方案

使用 API 配置费率卡方案详情,如以下几个部分所述。

使用 API 指定费率卡方案详细信息

您可以在创建费率方案时指定费率卡方案详细信息。您可以在调用 /organizations/{org_name}/monetization-packages/{package_id}/rate-plans 时在请求正文中的 ratePlanDetails 属性中指定详细信息。您在 ratePlanDetails 属性中指定的内容取决于您选择的计费模式:固定费率、按量分段或套餐。

指定固定费率充电模式

如需实现固定费率计费模式,您需要在费率方案详情中指定以下内容:

  • 一个评分参数,用于指明费率方案是基于交易 (VOLUME) 还是基于自定义属性(例如 MINT_CUSTOM_ATTRIBUTE_1)。VOLUME 是默认值。
  • 一种计量类型 (UNIT),表示每单位费率是固定的(也就是说,不像针对音量带状或套装收费模式那样基于交易量)。
  • 付款到期期限(例如 30 天)。
  • 您的组织的 ID。
  • 贵公司使用的“基准”或会计币种。
  • 费率方案的费率,详细说明费率的计算方式。由于计费模式基于固定费率,因此您只需指定一个费率方案费率。

在价格方案费率中,您可以指定:

  • 费率方案费率的类型 (RATECARD)。
  • 方案的费率。例如,如果您指定 0.10,且币种为美元,则系统会按每笔交易向开发者收取 0.10 美元(如果是基于自定义属性,例如交易中传输的字节数,则系统会按传输指定字节数向开发者收取 0.10 美元)。
  • 费率应用的起始单位 (0)。这意味着费率会应用于每笔交易,从第一笔交易开始。

如需查看费率方案详情选项的完整列表,请参阅费率方案详情配置设置

例如,以下代码会创建采用固定计费模式的费率卡方案。费率为每笔交易 0.10 美元。付款期限为 30 天。(与价目表相关的详细信息已突出显示。)

curl -H "Content-Type:application/json" -X POST -d \
'{ 
     "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": "{org_name}"
      },
      "ratePlanRates": [
       {
        "type": "RATECARD",
        "rate": "0.10",
        "startUnit": "0"       
       }      
      ], 
     "ratingParameter": "VOLUME",
     "type": "RATECARD"
     }],
     "recurringStartUnit": 1,
     "recurringType": "CALENDAR",
     "recurringFee": "10",
     "setUpFee": "10",
     "startDate": "2013-09-15 00:00:00",
     "type": "STANDARD"
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/location/rate-plans" \
-u email:password

指定容量分段充电模式

在卷带模型中,您可以指定包含一个或多个费率方案费率的费率方案详细信息,每个费率都适用于一个“卷带”,即交易量范围(或基于传输的字节数等自定义属性的范围)。此类方案通常旨在通过为更高的转化量段提供折扣费率,鼓励开发者提高转化量。

除了费率方案费率之外,您还可以在费率方案详细信息中指定以下各项:

  • 一个评分参数,用于指明费率方案是基于交易 (VOLUME) 还是基于自定义属性(例如 CUSTOM_ATTRIBUTE_1)。VOLUME 是默认值。
  • 一种计量类型 (VOLUME),表示费率基于交易量(即,不是与固定费率收费模式一样的固定每笔交易费率)。
  • 付款期限(例如 30 天)。
  • 您的组织的 ID。
  • 贵公司使用的“基准”或会计币种。
  • 时长和时长类型,二者共同指定交易量(或与自定义属性相关的交易量)的汇总时间段。这也称为“汇总依据”。系统会按汇总依据(例如 1 个月)汇总交易量,以确定适用的交易量段。
  • 用于确定适用卷带的汇总计数器。

对于每个价格方案费率,您需要指定:

  • 费率方案费率的类型 (RATECARD)。
  • 方案的费率。例如,如果您指定 0.10,且币种为美元,则系统会按每笔交易向开发者收取 0.15 美元(如果是基于自定义属性,例如交易中传输的字节数,则系统会按传输指定字节数向开发者收取 0.15 美元)。
  • 音量等级的开始和结束单位。起始单位指定音量带的下限,结束单位指定音量带的上限。例如,如果您将起始单位指定为 0,指定结束单位为 1000,则卷带在汇总期内最多可涵盖 1000 项事务。如果币种为美元,汇总期为 1 个月,前 1, 000 笔交易的费率为 0.15%,则系统会按每笔 0.15 美元的费率向开发者收取费用,每月最多 1, 000 笔交易。

    如需详细了解套餐的重置时间,请参阅何时收取周期性费用并重置套餐方案?

    如果您没有为最终音量区间指定结束单位,则系统会在交易次数超过该区间起始单位之后的所有交易应用该区间的费率。例如,如果最后一个组的起始单位为 1000,而您未为该组指定结束单位,则该组的费率将应用于汇总期内交易量达到 1000 笔后的所有交易。

如需查看费率方案详情选项的完整列表,请参阅费率方案详情配置设置

例如,以下代码会创建一个采用流量分段计费模式的费率卡方案。费率为前 1,000 笔交易 0.15 美元,超过 1,000 笔的所有交易 0.10 美元。汇总依据为 1 个月。付款期限为 30 天。(价目表详细信息已突出显示。)

curl -H "Content-Type:application/json" -X POST -d \

'{
     "name": "Volume banded rate card plan",
     "developer":null,
     "developerCategory":null,
     "currency": {
      "id" : "usd"
     },     
     "frequencyDuration": "30",
     "description": "Volume banded rate card plan",
     "displayName" : "Volume banded 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"
      },
      "aggregateStandardCounters": true,
      "paymentDueDays": "30",
      "duration": "1",
      "durationType": "MONTH",
      "meteringType": "VOLUME",
      "organization": {
       "id": "{org_name}"
      },      
      "ratePlanRates": [
      {
       "type": "RATECARD",
       "rate": "0.15",
       "startUnit": "0",
       "endUnit": "1000"
      },
      {
       "type": "RATECARD",
       "rate": "0.10",
       "startUnit": "1000"      
      }
      ],     
     "ratingParameter": "VOLUME",
     "type": "RATECARD"
     }],
     "recurringStartUnit": 1,
     "recurringType": "CALENDAR",
     "recurringFee": "10",
     "setUpFee": "10",
     "startDate": "2013-09-15 00:00:00",
     "type": "STANDARD"
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/location/rate-plans" \
-u email:password

指定捆绑式充电模式

在捆绑收费模式中,开发者为“捆绑”交易(或根据传输的字节数等自定义属性为“捆绑”交易)付费(预先付费)。您可以为每个软件包指定费率和汇总基准,即开发者可以使用软件包的时长。

例如,假设您设置了两个软件包,其中第一个软件包大小为 1-1000 事务,第二个软件包大小为 1001-2000 事务。第一个捆绑包的费率为 50 美元,第二个捆绑包的费率为 40 美元,汇总基准为 1。如果开发者为第一个套餐购买费率卡方案,则需要支付 50 美元(预付款),即可在一个月内完成 1, 000 笔交易。无论套装是否全部使用完毕,开发者都需要支付固定金额。 汇总期结束后,方案会到期。如果开发者想再次使用该套餐,则必须重新购买方案(以及套餐)。

您在费率方案详情中指定的内容与您在流量分段式计费模式的费率方案详情中指定的内容基本相同。区别如下:

  • 您指定的每个费率方案都适用于套餐(而非播放量段)。
  • 您必须为最后一个软件包指定上限,除非您想针对最后一个软件包中的无限交易向开发者收取固定金额。

如需查看费率方案详情选项的完整列表,请参阅费率方案详情配置设置

例如,以下代码会创建一个采用捆绑式结算模式的费率卡方案。第一捆(最多 1,000 笔交易)的费率设为 50 美元,第二捆(超过 1,000 笔交易,最多 2,000 笔交易)的费率设为 40 美元。汇总依据为 1 个月。付款期限为 30 天。

curl -H "Content-Type:application/json" -X POST -d \
'{
     "name": "Bundled rate plan",
     "developer":null,
     "developerCategory":null,
     "currency": {
      "id" : "usd"
     },    
     "frequencyDuration": "30",
     "description": "Bundled rate plan",
     "displayName" : "Bundled rate plan",
     "frequencyDurationType": "DAY",
     "earlyTerminationFee": "10",
     "monetizationPackage": {
      "id": "location"
     },
     "organization": {
      "id": "{org_name}"
     },    
     "paymentDueDays": "30",
     "prorate": "true",
     "published": "true",
     "ratePlanDetails": [
     {
      "currency": {
       "id" : "usd"
      },
      "aggregateStandardCounters": true,
      "paymentDueDays": "30",
      "duration": "1",
      "durationType": "MONTH",
      "meteringType": "STAIR_STEP",
      "organization": {
       "id": "{org_name}"
      },
      "ratePlanRates": [
      {
       "type": "RATECARD",
       "rate": "50",
       "startUnit": "0",
       "endUnit": "1000"
      },
      {
       "type": "RATECARD",
       "rate": "40",
       "startUnit": "1000",
       "endUnit": "2000"
      }
      ],
     "ratingParameter": "VOLUME",
     "type": "RATECARD"
     }],
     "recurringStartUnit": 1,
     "recurringType": "CALENDAR",
     "recurringFee": "10",
     "setUpFee": "10",
     "startDate": "2013-09-15 00:00:00",
     "type": "STANDARD"
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/location/rate-plans" \
-u email:password

使用 API 为各个产品指定免费增强型应用方案

在价目表方案中,您可以为单个产品(而不是 API 套餐)设置免费增值方案。免费增值方案可让开发者在一段时间内或根据用量免费使用 API 产品。

为 API 产品设置免费增强型方案时,您可以在费率卡方案详情中指定开发者可以免费使用 API 产品提供的资源的时段。该时间段可以基于以下任一条件:

  • 时长,即生效日期与结束日期之间的时间。
  • 数量,例如涉及 API 产品的交易数量,或交易记录政策中记录的自定义属性的相关交易量。

如果免费增值期基于数量,请将其指定为免费增值单位的数量。例如,以下示例创建了一个价目表方案,该方案包含基于数量为 5, 000 个单元的免费增值方案(突出显示了与免费增值相关的规范)。

curl -H "Content-Type:application/json" -X POST -d \
'{
      "name": "Flat rate card plan with freemium period",
      "developer":null,
      "developerCategory":null,      
      "advance": "false",
      "currency": {
       "id" : "usd"
      },     
      "description": "Flat rate card plan with freemium period",
      "displayName" : "Flat rate card plan with freemium period",
      "frequencyDuration": "30",
      "frequencyDurationType": "DAY",
      "earlyTerminationFee": "10",     
      "monetizationPackage": {
       "id": "location"
      },
      "organization": {
       "id": "myorg"
      },
      "paymentDueDays": "30",
      "prorate": "false",
      "published": "false",
      "ratePlanDetails": [
      {
       "currency": {
       "aggregateFreemiumCounters" : true,
       "aggregateStandardCounters" : true,
        "id" : "usd"
       },
       "product" : {
        "id" : "location",
        "displayName":"Location"
       },
       "paymentDueDays": "30",      
       "meteringType": "UNIT",
       "organization": {
        "id": "myorg"
       },
       "ratePlanRates": [
        {
         "type": "RATECARD",
         "rate": "0.10",
         "startUnit": "0"       
        }      
       ],
      "freemiumUnit": "5000",
      "freemiumDuration": "0",
      "freemiumDurationType": "DAY",
      "ratingParameterUnit":"MB",
      "customPaymentTerm": "false",
      "ratingParameter": "VOLUME",
      "type": "RATECARD"
      }],
      "recurringStartUnit": 1,
      "recurringType": "CALENDAR",
      "recurringFee": "10",
      "setUpFee": "10",
      "startDate": "2013-09-15 00:00:00",
      "type": "STANDARD"
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/location/rate-plans" \
-u email:password