<ph type="x-smartling-placeholder"></ph>
您正在查看 Apigee Edge 文档。
转到
Apigee X 文档。 信息
简介
在价目表方案中,开发者需要为每笔交易付费。对于此类方案 需要提供更多详细信息,例如充电模式和充电模式的价格。
您也可以选择为单个产品(而不是为 API)指定免费增值方案 - 只能对特定产品的计划执行此操作。
何时收取周期性费用以及何时重置套餐方案?
价格方案可以包括周期性费用以及 API 套餐(Volume Banded 和 Bundle 套餐), 两者都涉及特定的收费时间,并且套装方案会重置为零。通过 下表介绍了周期性费用的收取时间以及套装计数的重置时间。如果 开发者应用被阻止进行进一步的 API 调用,因为它们已达到 交易限额时,API 调用次数会重置为零,应用 可以重新开始拨打电话
如果方案... | ...这种情况发生了 |
---|---|
|
周期性费用和套装方案会在每月第一天重置(默认设置)。 对于每月在某一天的重复周期,请使用管理部分创建费率方案
API,并使用 |
|
在开发者费率结束后,系统会每 7 天重置一次周期性费用和套装方案 方案开始日期。 |
|
周期性费用和套装方案每 X 天重置一次,有效期为 开发者费率方案的开始日期 |
|
系统会根据价目表中定义的“汇总依据”重置套装方案。对于 例如,如果某个开发者在每月 19 日开始实施费率方案,而“汇总” 基础价格为每 1 个月,然后系统会在每月 19 号重置套装用量。 请注意,一个月中的具体日期可能并不总是相同。例如,如果某个费率 方案的开始日期为 12 月 31 日,重置日期将变为平年的第 28 天 因为二月份只有 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)。
点击 +新建可添加其他内容集。您必须为最后一个 app bundle 指定一个上限,除非您想针对最后一个 app bundle 中的无限制交易向开发者收取固定金额的费用。 注意:您可以使用 API(而不是界面)配置可针对费率指定的小数位数。如需了解详情,请参阅配置费率方案费率的小数位数。 例如,如果您在“资料包大小”部分中指定了两个套装(介于 0 到 1000 之间,大于 1000 到 2000 的套装),您可以输入 50 表示大于 0 到 1000 的套装,以及为大于 1000 且不超过 2000 的套装输入 40。如果选择的货币为美元,那么第一个套装的价格为 50 美元,第二个套装的价格为 40 美元。无论开发者在该套装中使用了多少笔交易,都需要支付适用的套装价格(即,开发者会在套装中的第一笔交易完成后立即按套装价格付费)。 |
如果您为 API 产品定义了自定义属性,则可以配置自定义评分参数,以便根据每笔交易中的自定义属性向应用开发者收费。例如,如果您设置了向开发者收取每笔交易费用的方案,则可以根据自定义属性(例如在后端传输的字节数)设置该方案的费率,具体费率因交易而异。
在这种情况下,请选择使用自定义评分参数,然后从下拉列表中选择自定义属性。如需了解详情,请参阅使用自定义属性配置费率方案。
传统 Edge(私有云)
如需使用传统 Edge 界面配置价目表方案,请执行以下操作:
- 按照相应步骤创建价格方案。
- 在“费率方案类型”下拉菜单中选择价目表,以配置收入模式。
- 如果所选 API 软件包包含多个 API 产品,请选择以下选项之一:
注意:如果 API 软件包中仅包含单个 API 产品,您可以跳过此步骤。
- 产品专用方案:用于单独配置每个 API 产品的费率方案详情。
- 适用于所有产品的通用方案:用于为所有 API 产品配置费率方案详情。
- 点击价目表,查看通用费率方案或每个 API 产品专用费率方案。
注意:在配置 API 产品专用方案时,您需要配置相应的价目表方案 。
此时会打开“价目表”窗口。
- 为 API 产品设置免费增值方案。免费增值方案可让开发者免费使用
一段时间内或使用量的 API 产品。
请输入以下信息:
字段 说明 免费增值产品? 免费期的范围。选择下列其中一个单选按钮:
- 按数量。免费期基于“卷”中指定的数量 字段。
- 按时长。收费期限以 “免费增值时长”字段。
- 二者取其先。当 “数量”字段或“免费增值时长”字段中的时间间隔已到, 二者取其先。
- 不可以,这不是免费增值方案。这是默认值。
免费增值交易量 交易量(或 交易记录政策),而开发者无需为此付费。当前音量为 和衡量 API 产品的标准。输入卷号,例如 5000。这意味着 当开发者启动该方案时,他们无需为前 5, 000 笔交易支付费用 (或针对自定义属性相关商品的前 5000 次使用)。此字段为 您必须先选择“按数量”或“二者取其先”在“免费增值”策略中 产品?”字段。
免费增值期限 不向开发者收费的时间间隔。输入一个数字并 选择一个时间段,例如“1 个月”。这意味着开发者 按 1 个月计费。只有在选择“按时长”时,系统才会启用此字段或 “二者取其先”“Freemium Product?”字段。
- 请选择以下充电模式之一:
<ph type="x-smartling-placeholder">
- </ph>
- 固定费率。在此模型中,开发者按固定费率支付 交易。
- 带音量条带。在此模型中,开发者根据 和交易量
- 套装。在此模式中,对于每 100 次展示,开发者需要预先支付 事务集合无论捆绑销售与否,开发者均需支付设定的金额 。
对于固定费率模式:在 通用价目表窗口:
字段 说明 运营商(或组织) 您的组织的名称。此字段是使用 Operator(或 组织)字段值。
国家/地区 贵组织的运营国家/地区。此字段是使用 组织资料中的国家/地区字段值。
统一费率 针对每笔交易收取的费率。请输入一个十进制数字(最多四位) 小数点)。
注意:您可以配置可指定的小数位数 使用 API(而不是界面)收取的费率。有关详情,请参阅配置 价格方案费率的小数位数。
例如,如果您输入 0.10,而货币为美元,那么开发者为 (或者,如果根据自定义属性(如 传输的字节数,则开发者需支付 0.10 美元, 传输指定数量的字节数)。
对于卷带式模型:“通用价目表”窗口会显示 用于指定汇总依据和“音量带”的字段, 是指您可以应用不同费率的交易量范围。
这类方案通常是为了鼓励开发者通过 为更高音量的频段提供折扣费率
在“通用价目表”窗口中输入以下信息:
字段 说明 汇总基础 交易量(或自定义 与属性相关的数据量)汇总。汇总量用于确定 卷范围和每笔交易适用的费率选择月数 (1-12 个月)。
有关何时重置套装,请参阅何时 收取的费用并重置套餐方案?
音量频段 一个或多个交易量范围(或基于客户属性)(每个范围) 是指“音量带”)。您可以为每个音量频段分配一个费率(您可以在 “价格”部分的“音量范围”字段。)该费率会应用于 事务处理。指定第一个 例如,最高可达 1000(下限预设为大于 0)。点击 + 可添加第二个频段,例如,大于 1000 到 2000。点击 + 可添加更多 乐队。您可以将最后一个频段的上限留空 高于此水平的交易次数。
价格 运营商(或组织) 您的组织的名称。此字段是使用 Operator(或 组织)字段值。
国家/地区 贵组织的运营国家/地区。此字段是使用 组织资料中的国家/地区字段值。
货币 “基础”或贵组织使用的会计币种。此字段为 使用“组织资料”中的“货币”字段值进行预设,但也可以 此处已更改。
音量频段 音量频段的速率。您需要为每个音量频段指定一个速率。请输入 每个频段的十进制数(最多四位小数)。
注意:您可以配置可指定的小数位数 (而不是通过界面)指定音量带速率的值。有关详情,请参阅配置 价格方案费率的小数位数。
例如,如果您在“Volume Band”部分中指定了两个音量带, (大于 0-1,000,以及大于 1,000),对于“>0-1,000”的卷,您可以输入 0.15 音量范围为 1000 及以上,为 0.10。如果所选币种为美国 前 1000 笔交易的费率为每笔交易 0.15 美元,并且 对于超过 1000 笔交易,则每笔交易的费率为 0.10 美元。
对于捆绑式模式:“通用价目表”窗口会显示 用于指定汇总依据(开发者可以在多长时间内 事务包),并指定与包相关的信息(例如 软件包。
在“通用价目表”窗口中输入以下信息:
字段 说明 汇总基础 开发者可以使用交易包的期限(或 使用基于属性的自定义集合)。选择月份数(1-12 个月)。更新后 在此期间,方案会过期,开发者必须购买方案(和套装) 。
有关何时重置套装,请参阅何时 收取的费用并重置套餐方案?
套装大小 套装中的交易次数(或与自定义属性相关的数字) 例如,捆绑包中传输的总字节数)。每个 bundle 都可以分配给 价格(您可以在“定价”部分的“套装大小”字段中设置此价格)。通过 价格将适用于整个套装。指定第一个捆绑包的上限, 例如,最高为 1000(下限预设为大于 0)。点击 + 可添加 例如,介于 1000 到 2000 之间。点击 + 可添加更多 软件包。您必须为最后一个广告素材集合指定一个上限,除非您 针对最近一笔无限制交易的交易向开发者收取固定金额的费用 软件包。
价格 运营商(或组织) 您的组织的名称。此字段是使用 Operator(或 组织)字段值。
国家/地区 贵组织的运营国家/地区。此字段是使用 组织资料中的国家/地区字段值。
货币 “基础”或贵组织使用的会计币种。此字段为 使用“组织资料”中的“货币”字段值进行预设,但也可以 此处已更改。
套装大小(价格) 套装的价格。您需要为每个套装指定价格。请输入小数 数字(最多精确到小数点后四位)。
注意:您可以配置可指定的小数位数 了解套装费率的计算方法,而不是通过界面。有关详情,请参阅配置 价格方案费率的小数位数。
例如,如果您在“Bundle Size”(套装大小)部分中指定了两个套装(大于 0), (最高 1000,大于 1000 到 2000),则可以输入 50 以表示 0 至 1000 之间的组合,以及 40 为 1000 至 2000 的套装。如果 所选币种为美元,第一个套装的价格为 50 美元, 第二个套装的价格是 40 美元开发者需按适用的套装价格支付费用 而不管他们在 bundle 中使用了多少事务(即 在套装中的首笔交易中,系统会立即向开发者收取套装价格的费用 已完成。)
- 点击应用并关闭,保存价目表详细信息并返回“标准价目表” 窗口。
- 对于 API 产品专用的费率方案,可根据需要为其他 API 产品配置费率方案详细信息。
使用 API 配置价目表方案
使用 API 配置价目表方案详情,如以下部分所述。
使用 API 指定价目表方案详情
您可在创建费率方案时指定价目表方案详细信息。您可以在
请求标头中的 ratePlanDetails
属性
/organizations/{org_name}/monetization-packages/{package_id}/rate-plans
。您
具体取决于您选择的充电模式:ratePlanDetails
固定费率、音量带状或套装。
指定一个 统一费率收费模式
若要实施固定费率收费模式,请在费率方案中指定以下内容 详细信息:
- 评分参数,表示费率方案基于交易
(
VOLUME
) 或自定义属性(例如,MINT_CUSTOM_ATTRIBUTE_1
)。VOLUME
是默认值。 - 一种计量类型 (
UNIT
),表示每单位费率是固定的(即 它不以交易次数为依据,这与适用于不同数量区间或 捆绑销售模式)。 - 付款期限(例如 30 天)。
- 贵组织的 ID。
- “基础”或公司使用的会计货币。
- 费率方案的费率,详细说明费率的计算方式。由于 费率模式基于固定费率,因此您只能指定一个费率方案费率。
在价格方案费率中,您可以指定:
- 费率方案费率的类型 (
RATECARD
)。 - 方案的费率。例如,如果您指定 0.10,货币为美元, 对于每笔交易(或如果基于自定义属性,如 在一项事务中传输的字节数,开发者要支付 0.10 美元, 传输指定数量的字节数)。
- 房价应用的起始单位 (
0
)。这意味着 从第一笔交易开始计算
请参阅费率方案 详情配置设置,查看价格方案详情选项的完整列表。
例如,以下代码创建了一个采用固定费用模式的价目表方案。费率为 设置为每笔交易 0.10 美元付款应在 30 天后到期。(与价目表相关的详细信息包括 highlighted.)
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,则音量带会涵盖
汇总期内最多 1,000 笔交易。如果币种为美元,
汇总期为 1 个月,且前 1000 笔交易的费率为 0.15,则
当月针对 1,000 笔交易,开发者需为每笔交易支付 0.15 美元。
如需详细了解套装何时重置,请参阅何时收取周期性费用 并重置套装方案?
如果您没有为最终音量频段指定结束单位,则该频段的费率为 在交易次数超出起始单位后应用于所有交易 例如,假设最后一个乐队的起始单位是 1000,而您没有将 指定该区间的结束单位,则该区间的费率将应用于所有交易 在汇总期内达到 1000 笔交易后。
请参阅费率方案 详情配置设置,查看价格方案详情选项的完整列表。
例如,以下代码创建了一个包含音量带状充电模式的价目表方案。通过 前 1000 笔交易的费率设置为 0.15 美元,所有超过 1000 笔交易的费率设置为 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 事务。对于 第二个套装为 40 美元,汇总基数为 1。如果开发者 购买了第一个套装的价目表方案,他们需支付 50 美元(预付) 一个月。无论套装是否全部使用,开发者都需要支付设定的金额。 汇总期结束后,方案会过期。如果开发者想要使用 bundle 必须再次购买套餐(和套餐)。
您在价格方案详情中指定的内容与您在 卷带式充电模式的费率方案详情。区别如下:
- 您指定的每个费率方案都是一个套装(而不是一个音量区间)。
- 您必须为最后一个套装指定一个上限,除非您 开发者可针对最后一个套装提供固定金额的无限制交易。
请参阅费率方案 详情配置设置,查看价格方案详情选项的完整列表。
例如,以下代码创建了一个包含捆绑费用模式的价目表方案。费率为 为第一个套装(最多 1,000 笔交易)设置为 50 美元,为第二个套装(最多 1000 笔)设置为 40 美元 和最多 2,000 笔交易)。汇总基准为 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 产品的交易次数或交易量 。
如果免费增值期基于数量,请将其指定为免费增值单位的数量。对于 下面的示例创建了一个价目表方案,其中包含基于数量 5000 的免费增值方案 单位(突出显示了与免费增值相关的规范)。
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