配置价目表方案

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

简介

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

您可以选择为单个产品（而非 API 软件包）指定免费增值方案，但只能为特定于产品的方案执行此操作。

系统何时收取定期费用以及重置套餐方案？

费率方案可以包括定期费用以及 API 套餐（按量分级和套餐方案），这两者都涉及费用收取和套餐方案重置为零的具体时间。下表介绍了何时收取周期性费用以及何时重置套餐数量。如果开发者应用因达到特定交易限额而被阻止进一步进行 API 调用，则在这些时间，API 调用的计数会重置为零，应用可以再次开始进行调用。

如果方案包含… …会出现以下情况
  • 设置为 月的非零周期性费用
  • 流量包或套餐

定期费用和套装方案重置发生在每月的第一天（默认）。

如需按特定日期每月重复一次，请使用管理 API 创建费率方案，并使用 RecurringStartUnit 属性指明日期，如使用 API 创建费率方案中所述。
  • 非零的周期性费用，设置为周
  • 流量包或套餐
 定期费用和套装方案重置时间为开发者费率方案开始日期后的每 7 天。
  • 非零的周期性费用设置为天
  • 流量包或套餐
 重复性费用和套装方案重置发生在开发者费率方案开始日期后的每 X 天。
  • 无（或零美元）经常性费用
  • 流量包或套餐

系统会根据费率卡上定义的“汇总依据”重置捆绑方案。例如，如果开发者在当月的 19 日开始使用费率方案，并且“汇总依据”为“每 1 个月”，则套装使用量会在每个月的 19 日重置。

请注意，每月中的具体日期可能并不总是相同。例如，如果某个费率方案从 12 月 31 日开始，则在非闰年的 2 月，重置日期会变为 28 日，因为 2 月只有 28 天。然后，28 日将成为永久的重置日期。

使用界面配置价目表方案

配置费率卡方案，如下所述。

Edge

如需配置价目表方案，请在创建或修改费率方案时，选择价目表或价目表和收益分成费率方案类型，然后在价目表部分中选择以下某种收费模式：

充电模式 说明
统一费率 对于每笔交易，系统会按固定费率向开发者收费。
按量分段 开发者需支付可变费率，具体取决于交易量。
套装 对于每组交易，系统会预先向开发者收取一定金额的费用。无论是否完全使用套装，开发者都需要支付设置的金额。

注意：如果您选择“价目表和收入分成”，此选项将不可用。

然后，根据所选的收费模式配置以下信息。

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

注意：您可以使用 API（而非界面）配置可为所收取的费率指定的小数位数。如需了解详情，请参阅配置费率方案费率的小数位数。

例如，如果您输入 0.10，并且币种为美元，那么系统会针对每笔交易向开发者收取 0.10 美元（或者，如果费用基于自定义属性，例如交易中传输的字节数，那么系统会针对传输的指定字节数向开发者收取 0.10 美元）。

按量分段 音量频段 采用分档收费模式时，一个或多个交易（或基于客户属性的）量范围（每个范围都是一个“量档”）。您可以为每个流量频段分配费率。该费率适用于相应交易量区间的全部交易。指定第一个区间的上限，例如最高为 1000（下限预设为大于 0）。

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

将最后一个区间的上限留空，表示高于此级别的所有交易。

注意：您可以使用 API（而非界面）配置可为所收取的费率指定的小数位数。如需了解详情，请参阅配置费率方案费率的小数位数。

例如，如果您在“Volume Band”（交易量区间）部分指定了两个交易量区间（>0-1000 和 1000 及以上），则可以为“>0-1000”交易量区间输入 0.15，为“1000 及以上”交易量区间输入 0.10。如果所选币种为美元，则前 1,000 笔交易的费率为每笔交易 0.15 美元，超过 1,000 笔交易的费率为每笔交易 0.10 美元。

套装 API 软件包价格 一个软件包中的交易数量（或与自定义属性相关的数字，例如一个软件包中传输的总字节数）。您可以为每个套装指定价格。该价格适用于整个套装。指定第一个套装的上限，例如最高 1,000（下限预设为大于 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 Duration”（免费增值时长）字段中指定的时间间隔。
    • 以先到者为准。当达到“数量”字段中的数量或“免费增值时长”字段中的时间间隔时（以先达到的条件为准），免费期即会结束。
    • 不是，这不是免费增值方案。这是默认值。
    Freemium Volume

    开发者无需付费的交易量（或交易记录政策中记录的与自定义属性相关的交易量）。系统会针对 API 产品衡量此流量。输入一个音量值，例如 5000。这意味着，当开发者开始使用该方案时，前 5,000 笔交易（或前 5,000 次使用与自定义属性相关的项）不会产生费用。只有在“Freemium Product?”字段中选择“按数量”或“以先到者为准”时，此字段才会启用。
    免费增值时长

    开发者无需付费的时间间隔。输入一个数字并选择一个时间段，例如“1 个月”。这意味着开发者无需支付 1 个月的费用。只有在“freemium Product?”字段中选择“按时长”或“以先到者为准”时，此字段才会启用。
  6. 选择以下某种收费模式：
    • 统一费率。在此模式下，开发者需为每笔交易支付固定费率。
    • 按量分级。在此模式下，系统会根据交易量向开发者收取可变费率。
    • 套装。在此模式下，开发者需要为每组交易预先支付一笔固定金额。无论套装是否完全使用，开发者都需要支付设置的金额。

    对于固定费率模式：在“通用费率卡”窗口的“价格”部分中，输入以下信息：

    字段 说明
    运营商（或组织）

    您的组织的名称。此字段会使用组织个人资料中的“运营商”（或“组织”）字段值进行预设。
    国家/地区

    贵组织的运营国家/地区。此字段会使用组织个人资料中的“国家/地区”字段值进行预设。
    统一费率

    每笔交易的收费费率。输入一个小数（最多包含四位小数）。

    注意：您可以使用 API（而非界面）配置可为所收取的费率指定的小数位数。如需了解详情，请参阅配置费率方案费率的小数位数。

    例如，如果您输入 0.10，并且币种为美元，那么系统会针对每笔交易向开发者收取 0.10 美元（或者，如果费用基于自定义属性，例如交易中传输的字节数，那么系统会针对传输指定字节数向开发者收取 0.10 美元）。

    对于分级费率模式：“通用价目表”窗口会显示一些额外的字段，您可以使用这些字段来指定汇总依据和“交易量区间”，即您可以应用不同费率的交易量范围。

    这种类型的方案通常旨在鼓励开发者生成更多内容，因此会针对更高的量级范围提供折扣价。

    在“Generic Rate Card”（通用费率卡）窗口中输入以下信息：

    字段 说明
    汇总依据

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

    如需详细了解套装何时重置，请参阅系统何时收取周期性费用以及重置套装方案？
    音量频段

    一个或多个交易量（或基于客户属性的量）范围（每个范围都是一个“量频段”）。每个销量区间都可以分配一个费率（您可以在“价格”部分的“销量区间”字段中设置此费率）。该费率适用于相应交易量区间的全部交易。指定第一个区间的上限，例如最高为 1000（下限预设为大于 0）。点击 + 添加第二个频段，例如大于 1000 至 2000。点击“+”可添加更多频段。您可以将最终区间的上限留空，以表示高于此级别的所有交易。
    价格
    运营商（或组织）

    您的组织的名称。此字段使用组织个人资料中的“运营商”（或“组织”）字段值预设。
    国家/地区

    贵组织的运营国家/地区。此字段会使用组织个人资料中的“国家/地区”字段值进行预设。
    货币

    组织使用的“基本”或会计币种。此字段使用组织资料中的“币种”字段值进行预设，但可以在此处进行更改。
    成交量区间

    相应音量频段的费率。您可以为每个流量频段指定费率。为每个频段输入一个小数（最多可输入四位小数）。

    注意：您可以使用 API（而非界面）配置可为音量频段费率指定的小数位数。如需了解详情，请参阅配置费率方案费率的小数位数。

    例如，如果您在“Volume Band”（销量区间）部分指定了两个销量区间（>0-1000 和 1000 及以上），则可以为 >0-1000 销量区间输入 0.15，为 1000 及以上销量区间输入 0.10。如果所选币种为美元，则前 1,000 笔交易的费率为每笔交易 0.15 美元，超过 1,000 笔交易的费率为每笔交易 0.10 美元。

    对于捆绑式模型：“Generic Rate Card”（通用费率卡）窗口会显示其他字段，您可以使用这些字段指定汇总依据（开发者可以使用交易捆绑包的时间段），并指定与捆绑包相关的信息，例如捆绑包的大小。

    在“Generic Rate Card”（通用费率卡）窗口中输入以下信息：

    字段 说明
    汇总依据

    开发者可以使用交易包（或使用基于自定义属性的包）的时间段。选择月数（1-12 个月）。在此期限过后，方案即会过期，开发者必须重新购买方案（和套装）。

    如需详细了解套装何时重置，请参阅系统何时收取周期性费用以及重置套装方案？
    套装大小

    相应软件包中的交易数量（或与自定义属性相关的数字，例如软件包中传输的总字节数）。每个套装都可以分配一个价格（您可以在“价格”部分的“套装规模”字段中设置此价格）。价格适用于整个套装。指定第一个捆绑包的上限，例如最高为 1000（下限预设为大于 0）。点击“+”可添加第二个区间，例如，大于 1000 且小于等于 2000。点击“+”可添加更多套装。您必须为最后一个套装指定上限，除非您希望针对最后一个套装中的无限次交易向开发者收取固定费用。
    价格
    运营商（或组织）

    您的组织的名称。此字段使用组织个人资料中的“运营商”（或“组织”）字段值预设。
    国家/地区

    贵组织的运营国家/地区。此字段会使用组织个人资料中的“国家/地区”字段值进行预设。
    货币

    组织使用的“基本”或会计币种。此字段使用组织资料中的“币种”字段值进行预设，但可以在此处进行更改。
    套装大小（价格）

    套装的价格。您可以为每个套装指定价格。输入一个小数（最多保留四位小数）。

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

    例如，如果您在“套装规模”部分指定了两个套装（大于 0 至 1000，以及大于 1000 至 2000），则可以为“大于 0 至 1000”套装输入 50，为“大于 1000 至 2000”套装输入 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，那么开发者在该月内最多 1, 000 笔交易的每笔交易需支付 0.15 美元。

    如需详细了解套装何时重置，请参阅何时收取定期费用以及重置套装方案？

    如果您未为最终交易量区间指定结束单位，则该区间的费率将应用于交易量超过该区间起始单位数后的所有交易。例如，如果最后一个区段的起始单位为 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