料金表プランを構成する

Apigee Edge のドキュメントを表示しています。
Apigee X のドキュメントに移動します。 情報

はじめに

レートカード プランでは、デベロッパーはトランザクションごとに課金されます。このタイプのプランでは、課金モデルや課金モデルの料金などの追加情報を提供する必要があります。

必要に応じて、個々の商品（API パッケージではなく）のフリーミアム プランを指定できます。これは商品固有のプランでのみ可能です。

定期料金の請求とバンドル プランのリセットはいつ行われますか？

料金プランには、定期的な料金と API バンドル（ボリューム バンドプランとバンドルプラン）を含めることができます。どちらも、料金が請求される特定の時間と、バンドルプランがゼロにリセットされる特定の時間が含まれます。次の表に、定期的な料金が請求され、バンドル数がリセットされるタイミングを示します。デベロッパー アプリが特定の取引限度額に達したために、それ以上の API 呼び出しがブロックされた場合、API 呼び出しのカウントがゼロにリセットされ、アプリが再び呼び出しを開始できるのは、次のタイミングです。

プランに次のいずれかが含まれている場合: ...この場合
  • 月に設定されたゼロ以外の定期料金
  • ボリューム バンドル プランまたはバンドル プラン

定期的な料金とバンドル プランのリセットは、月の初日（デフォルト）に行われます。

特定の日付に毎月繰り返す場合は、管理 API を使用して料金プランを作成し、RecurringStartUnit プロパティで日付を指定します。API を使用して料金プランを作成するをご覧ください。
  • 週に設定されたゼロ以外の定期料金
  • ボリューム バンドル プランまたはバンドル プラン
 定期的な料金とバンドルプランのリセットは、デベロッパーの料金プランの開始日から 7 日ごとに行われます。
  • 日に設定されたゼロ以外の定期料金
  • ボリューム バンドル プランまたはバンドル プラン
 定期的な料金とバンドル プランのリセットは、デベロッパーの料金プランの開始日から X 日ごとに行われます。
  • 定期的な料金なし（または 0 ドル）
  • ボリューム バンドル プランまたはバンドル プラン

バンドルプランは、レートカードで定義された集計基準に基づいてリセットされます。たとえば、デベロッパーが月の 19 日にレートプランを開始し、集計基準が 1 か月ごとである場合、バンドルの使用量は毎月 19 日にリセットされます。

なお、日付は必ずしも同じになるとは限りません。たとえば、料金プランが 12 月 31 日に開始される場合、2 月は 28 日しかないため、うるう年以外の 2 月の 28 日がリセット日になります。28 日がリセット日として設定されます。

UI を使用して料金表プランを構成する

以下の説明に沿って、料金表プランを構成します。

エッジ

レート表プランを設定するには、レートプランを作成または編集する際に、レートプランのタイプとして [レート表] または [レート表と収益分配] を選択し、[レート表] セクションで次のいずれかの課金モデルを選択します。

充電モデル 説明
定額制 デベロッパーには、トランザクションごとに固定料金が課金されます。
Volume Banded デベロッパーには、取引量に応じて変動料金が課金されます。
バンドル デベロッパーは、トランザクションのバンドルごとに一定の金額を前払いします。バンドルが完全に利用されたかどうかに関係なく、デベロッパーには設定された金額が請求されます。

注: [レートカード] と [収益分配] を選択している場合、このオプションは使用できません。

次に、選択した課金モデルに基づいて次の情報を構成します。

課金モデル フィールド 説明
すべて 計算頻度 トランザクションの量（またはカスタム属性に関連する量）が計算される期間。月数（1 ～ 24 か月）を選択します。
定額制 フラットレート トランザクションごとに課金される料金。小数（小数点以下 4 桁まで）を入力します。

注: 料金に指定できる小数点以下の桁数は、API（UI ではない）を使用して構成できます。詳しくは、料金プランの料金の小数点以下の桁数を構成するをご覧ください。

たとえば、0.10 と入力し、通貨が米ドルの場合、デベロッパーはトランザクションごとに 0.10 ドルを請求されます（または、トランザクションで送信されたバイト数などのカスタム属性に基づく場合、デベロッパーは指定されたバイト数を送信するごとに 0.10 ドルを請求されます）。

Volume Banded 音量帯域 ボリューム バンド課金モデルのトランザクション（または顧客属性ベース）のボリュームの 1 つ以上の範囲（各範囲は「ボリューム バンド」）。各ボリューム帯域にレートを割り当てることができます。このレートは、該当する取引量帯のすべての取引に適用されます。最初の帯域の上限を指定します（例: 1,000 まで。下限は 0 より大きい値にプリセットされています）。

[+ 新規] をクリックして、バンドを追加します。

最終的な帯域の上限を空白のままにすると、このレベルを超えるすべてのトランザクションが示されます。

注: 料金に指定できる小数点以下の桁数は、API（UI ではない）を使用して構成できます。詳しくは、料金プランの料金の小数点以下の桁数を構成するをご覧ください。

たとえば、[音量帯域] セクションで 2 つの音量帯域（>0 ～ 1, 000 と 1, 000 以上）を指定した場合、>0 ～ 1,000 の音量帯域には 0.15、1, 000 以上の音量帯域には 0.10 と入力します。選択した通貨が米ドルの場合、最初の 1,000 件の取引のレートは 1 件あたり $0.15 で、1,000 件を超える取引のレートは 1 件あたり $0.10 です。
バンドル API バンドルの料金 バンドル内のトランザクション数（またはバンドル内で送信されたバイト数の合計などのカスタム属性に関連する数値）。各バンドルに価格を割り当てることができます。価格はバンドル全体に適用されます。最初のバンドルの上限を指定します（例: 1,000 まで。下限は 0 より大きい値にプリセットされています）。

[+ 新規] をクリックして、バンドルを追加します。最後のバンドルで無制限の取引に対してデベロッパーに固定額を請求する場合を除き、最後のバンドルの上限を指定する必要があります。

注: 料金に指定できる小数点以下の桁数は、API（UI ではない）を使用して構成できます。詳しくは、料金プランの料金の小数点以下の桁数を構成するをご覧ください。

たとえば、[バンドルサイズ] セクションで 2 つのバンドル（0 より大きく 1,000 以下、1,000 より大きく 2,000 以下）を指定した場合、0 より大きく 1,000 以下のバンドルに 50、1,000 より大きく 2,000 以下のバンドルに 40 を入力します。選択した通貨が米ドルの場合、最初のバンドルの価格は $50、2 番目のバンドルの価格は $40 です。デベロッパーは、バンドル内で使用した取引の数にかかわらず、該当するバンドル料金を支払います（つまり、バンドル内の最初の取引が完了するとすぐにバンドル料金が請求されます）。

API プロダクトにカスタム属性を定義した場合は、各トランザクション内のカスタム属性に基づいてアプリ デベロッパーに課金するように、カスタム レート パラメータを構成できます。たとえば、トランザクションごとにデベロッパーに課金するプランを設定する場合、トランザクションごとに異なるバックエンドで送信されるバイト数などのカスタム属性に基づいてプランの料金を設定できます。

この場合は、[カスタム評価パラメータを使用する] を選択し、プルダウン リストからカスタム属性を選択します。詳細については、カスタム属性付きの料金プランを構成するをご覧ください。

Classic Edge（Private Cloud）

Classic Edge UI を使用してレートカード プランを構成するには:

  1. 手順に沿って料金プランを作成します。
  2. [Rate Plan Type] プルダウンで [Rate Card] を選択して、収益モデルを構成します。
  3. 選択した API パッケージに複数の API プロダクトが含まれている場合は、次のいずれかのオプションを選択します。

    注: API パッケージに 1 つの API プロダクトが含まれている場合は、この手順をスキップできます。

    • プロダクト固有のプラン: 各 API プロダクトの料金プランの詳細を個別に構成します。
    • すべての API プロダクトの料金プランの詳細を構成する [Generic Plan for All Products]。
  4. 一般的な料金プランまたは API プロダクト固有の料金プランごとに、[料金表] をクリックします。

    注: API プロダクト固有のプランを構成する場合は、API プロダクトごとに個別にレートカード プランを構成する必要があります。

    [レートカード] ウィンドウが開きます。

  5. API プロダクトのフリーミアム プランを設定します。フリーミアム プランでは、デベロッパーは一定期間または使用量に基づいて API プロダクトを無料で使用できます。

    次の情報を入力します。

    フィールド 説明
    フリーミアム製品ですか？

    無料期間の長さ。次のいずれかのラジオボタンを選択します。

    • 数量別。無料期間は、[Volume] フィールドで指定された数量に基づきます。
    • [期間] で並べ替えます。料金期間は、[Freemium Duration] フィールドで指定された時間間隔に基づきます。
    • いずれか早い方。無料期間は、[Volume] フィールドの数量または [Freemium Duration] フィールドの時間間隔のいずれかに達した時点で終了します。
    • いいえ。これはフリーミアム プランではありません。これがデフォルトです。
    フリーミアムのボリューム

    デベロッパーに課金されないトランザクションの量（またはトランザクション記録ポリシーに記録されたカスタム属性に関連する量）。ボリュームは API プロダクトに対して測定されます。ボリューム番号（5000 など）を入力します。つまり、デベロッパーがプランを開始したときに、最初の 5,000 件のトランザクション（またはカスタム属性関連アイテムの最初の 5,000 回の使用）に対しては課金されません。このフィールドは、[Freemium Product?]（フリーミアム製品ですか？）フィールドで [By Quantity]（数量別）または [Whichever comes first]（どちらか早い方）を選択した場合にのみ有効になります。
    フリーミアムの期間

    デベロッパーに料金が請求されない期間。数値を入力し、期間（1 か月など）を選択します。つまり、デベロッパーは 1 か月間料金を請求されません。このフィールドは、[フリーミアム商品ですか？] フィールドで [期間別] または [どちらか早い方] を選択した場合にのみ有効になります。
  6. 次のいずれかの課金モデルを選択します。
    • 定額制。このモデルでは、デベロッパーはトランザクションごとに固定料金を支払います。
    • ボリューム バンド。このモデルでは、デベロッパーはトランザクションの量に応じて変動料金を支払います。
    • バンドル。このモデルでは、デベロッパーはトランザクションのバンドルごとに一定の金額（前払い）を支払います。バンドルが完全に使用されたかどうかにかかわらず、デベロッパーには設定された金額が請求されます。

    フラットレートモデルの場合: [Generic Rate Card] ウィンドウの [Pricing] セクションに次の情報を入力します。

    フィールド 説明
    事業者（または組織）

    組織の名前。このフィールドは、組織プロファイルの [Operator]（または [Organization]）フィールドの値を使用して事前設定されます。
    国

    組織の事業拠点の国。このフィールドは、組織プロファイルの [国] フィールドの値を使用して事前設定されます。
    定額制

    トランザクションごとに課金される料金。小数（小数点以下 4 桁まで）を入力します。

    注: 料金に指定できる小数点以下の桁数は、API（UI ではない）を使用して構成できます。詳細については、料金プランの料金の小数点以下の桁数を構成するをご覧ください。

    たとえば、0.10 と入力し、通貨が米ドルの場合、デベロッパーはトランザクションごとに $0.10 を請求されます（または、トランザクションで送信されたバイト数などのカスタム属性に基づく場合、デベロッパーは指定されたバイト数の送信に対して $0.10 を請求されます）。

    ボリューム帯域モデルの場合: [Generic Rate Card] ウィンドウに、集計の基準を指定し、「ボリューム帯域」、つまり、異なるレートを適用できるトランザクション ボリュームの範囲を指定するために使用する追加のフィールドが表示されます。

    このタイプのプランは通常、ボリューム帯域の割引率を高めることで、デベロッパーにボリュームの増加を促すように設定されています。

    [Generic Rate Card] ウィンドウで次の情報を入力します。

    フィールド 説明
    Aggregation Basis

    トランザクションの量（またはカスタム属性関連の量）が集計される期間。集計されたボリュームは、ボリューム帯域と各トランザクションに適用するレートを特定するために使用されます。月数（1 ～ 12 か月）を選択します。

    バンドルがリセットされるタイミングについて詳しくは、定期購入料金の請求とバンドル プランのリセットはいつ行われますか？をご覧ください。
    Volume Bands

    トランザクション（または顧客属性ベース）のボリュームの 1 つ以上の範囲（各範囲は「ボリューム帯域」）。各ボリューム帯域にはレートを割り当てることができます（このレートは [料金] セクションの [ボリューム帯域] フィールドで設定します）。このレートは、該当するボリューム帯域のすべての取引に適用されます。最初の帯域の上限を指定します（例: 1,000 まで。下限は 0 より大きい値にプリセットされています）。[+] をクリックして、2 つ目の帯域（1, 000 超～ 2, 000 など）を追加します。[+] をクリックしてバンドを追加します。最終的な帯域の上限を空白のままにすると、このレベルを超えるすべてのトランザクションが示されます。
    料金
    事業者（または組織）

    組織の名前。このフィールドは、組織プロファイルの [Operator]（または [Organization]）フィールドの値を使用して事前設定されます。
    国

    組織の事業拠点の国。このフィールドは、組織プロファイルの [国] フィールドの値を使用して事前設定されます。
    通貨

    組織が使用する「基本」通貨または会計通貨。このフィールドは、組織プロファイルの [通貨] フィールドの値を使用して事前設定されていますが、ここで変更できます。
    音量帯域

    ボリューム帯域のレート。ボリューム帯域ごとにレートを指定します。各帯域の数値を入力します（小数点以下 4 桁まで）。

    注: 音量帯域のレートに指定できる小数点以下の桁数は、API（UI ではない）を使用して構成できます。詳細については、料金プランの料金の小数点以下の桁数を構成するをご覧ください。

    たとえば、[音量帯域] セクションで 2 つの音量帯域（>0 ～ 1, 000 と 1, 000 以上）を指定した場合、>0 ～ 1,000 の音量帯域には 0.15、1, 000 以上の音量帯域には 0.10 と入力します。選択した通貨が米ドルの場合、最初の 1,000 件の取引の手数料は 1 件あたり $0.15 で、1,000 件を超える取引の手数料は 1 件あたり $0.10 です。

    バンドルモデルの場合: [Generic Rate Card] ウィンドウに、集計の基準（デベロッパーがトランザクションのバンドルを使用できる期間）を指定したり、バンドルのサイズなどのバンドル関連情報を指定したりするために使用する追加のフィールドが表示されます。

    [Generic Rate Card] ウィンドウで次の情報を入力します。

    フィールド 説明
    Aggregation Basis

    デベロッパーがトランザクションのバンドルを使用できる期間（またはカスタム属性ベースのバンドルを使用できる期間）。月数（1 ～ 12 か月）を選択します。この期間が過ぎるとプランは期限切れとなり、デベロッパーはプラン（およびバンドル）を再度購入する必要があります。

    バンドルがリセットされるタイミングについて詳しくは、定期購入料金の請求とバンドル プランのリセットはいつ行われますか？をご覧ください。
    バンドルサイズ

    バンドル内のトランザクション数（またはバンドル内で送信されたバイト数の合計などのカスタム属性に関連する数値）。各バンドルに価格を割り当てることができます（この価格は [価格] セクションの [バンドルサイズ] フィールドで設定します）。価格はバンドル全体に適用されます。最初のバンドルの上限を指定します（例: 1,000 まで。下限は 0 より大きい値にプリセットされています）。[+] をクリックして、2 つ目のバンドル（1, 000 超 2, 000 以下など）を追加します。[+] をクリックしてバンドルを追加します。最後のバンドルで無制限の取引に対してデベロッパーに固定額を請求する場合を除き、最後のバンドルの上限を指定する必要があります。
    料金
    事業者（または組織）

    組織の名前。このフィールドは、組織プロファイルの [Operator]（または [Organization]）フィールドの値を使用して事前設定されます。
    国

    組織の事業拠点の国。このフィールドは、組織プロファイルの [国] フィールドの値を使用して事前設定されます。
    通貨

    組織が使用する「基本」通貨または会計通貨。このフィールドは、組織プロファイルの [通貨] フィールドの値を使用して事前設定されていますが、ここで変更できます。
    バンドルサイズ（価格）

    バンドルの価格。各バンドルの価格を指定します。小数（小数点以下 4 桁まで）を入力します。

    注: バンドル料金に指定できる小数点以下の桁数は、API（UI ではない）を使用して構成できます。詳細については、料金プランの料金の小数点以下の桁数を構成するをご覧ください。

    たとえば、[バンドルサイズ] セクションで 2 つのバンドル（0 より大きく 1,000 以下、1,000 より大きく 2,000 以下）を指定した場合、0 より大きく 1,000 以下のバンドルに 50、1,000 より大きく 2,000 以下のバンドルに 40 を入力します。選択した通貨が米ドルの場合、最初のバンドルの価格は $50、2 番目のバンドルの価格は $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。
  • 会社で使用している「基本」通貨または会計通貨。
  • 料金の計算方法の詳細を提供する料金プランの料金。課金モデルは固定レートに基づいているため、料金プランのレートは 1 つだけ指定します。

料金プランの料金では、次の項目を指定します。

  • 料金プランの料金のタイプ（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

ボリューム バンドの課金モデルを指定する

ボリューム帯域モデルでは、1 つ以上の料金プランの料金を含む料金プランの詳細を指定します。各料金は「ボリューム帯域」、つまりトランザクション ボリュームの範囲（または送信されたバイト数などのカスタム属性に基づく範囲）に適用されます。このタイプのプランは通常、ボリューム帯域が大きいほど割引率が高くなるように設定され、デベロッパーにボリュームの増加を促します。

料金プランの料金に加えて、料金プランの詳細で次の項目を指定します。

  • 料金プランが取引（VOLUME）に基づくか、カスタム属性（CUSTOM_ATTRIBUTE_1 など）に基づくかを示す料金パラメータ。デフォルトは VOLUME です。
  • レートがトランザクションの量に基づいていることを示す測定タイプ（VOLUME）（つまり、定額料金モデルのようにトランザクションごとの定額料金ではありません）。
  • お支払い期日（30 日間など）。
  • 組織の ID。
  • 会社で使用している「基本」通貨または会計通貨。
  • トランザクションの量（またはカスタム属性関連の量）が集計される期間を指定する期間と期間のタイプ。これは「集計基準」とも呼ばれます。トランザクションの量は、集計基準（1 か月など）で集計され、適用されるボリューム帯域が決定されます。
  • 適用可能なボリューム帯域を特定するために使用される集計カウンタ。

料金プランの料金ごとに、次の項目を指定します。

  • 料金プランの料金のタイプ（RATECARD）。
  • プランの料金。たとえば、0.10 を指定し、通貨が米ドルの場合、デベロッパーは各トランザクションに対して $0.15 を請求されます（または、トランザクションで送信されたバイト数などのカスタム属性に基づく場合は、指定されたバイト数の送信に対して $0.15 を請求されます）。
  • ボリューム バンドの開始単位と終了単位。開始単位はボリューム帯域の下限を指定し、終了単位はボリューム帯域の上限を指定します。たとえば、開始単位を 0、終了単位を 1, 000 に指定すると、集計期間のトランザクション数が 1, 000 までボリューム帯域が適用されます。通貨が米ドルで、集計期間が 1 か月、最初の 1, 000 件の取引のレートが 0.15 の場合、デベロッパーには、その月の 1, 000 件までの取引ごとに $0.15 が請求されます。

    バンドルがリセットされるタイミングについて詳しくは、定期的な料金の請求とバンドル プランのリセットはいつ行われますか？をご覧ください。

    最終的なボリューム帯域の終了単位を指定しない場合、その帯域のレートは、取引数がその帯域の開始単位を超えた後のすべての取引に適用されます。たとえば、最後の帯域の開始単位が 1, 000 で、その帯域の終了単位を指定しない場合、帯域のレートは集計期間内の 1, 000 件のトランザクション以降のすべてのトランザクションに適用されます。

料金プランの詳細オプションの一覧については、料金プランの詳細構成設定をご覧ください。

たとえば、次のコマンドは、ボリューム バンド型の課金モデルでレートカード プランを作成します。料金は、最初の 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 ～ 1, 000 件のトランザクション、2 番目のバンドルサイズを 1, 001 ～ 2, 000 件のトランザクションとして 2 つのバンドルを設定するとします。最初のバンドルの料金は $50、2 番目のバンドルの料金は $40 で、集計基準は 1 です。デベロッパーが最初のバンドルのレートカード プランを購入した場合、1 か月あたり 1, 000 件のトランザクションに対して $50（前払い）を支払います。バンドルが完全に使用されたかどうかにかかわらず、デベロッパーには設定された金額が請求されます。集計期間が終了すると、プランは期限切れになります。デベロッパーがバンドルを再度使用する場合は、プラン（とバンドル）を再度購入する必要があります。

料金プランの詳細で指定する内容は、ボリューム バンド課金モデルの料金プランの詳細で指定する内容と基本的に同じです。相違点は次のとおりです。

  • 指定する各料金プランは、バンドル用です（ボリューム帯域用ではありません）。
  • 最後のバンドルで無制限の取引に対してデベロッパーに固定額を請求する場合を除き、最後のバンドルの上限を指定する必要があります。

料金プランの詳細オプションの一覧については、料金プランの詳細構成設定をご覧ください。

たとえば、次のコマンドは、バンドルされた課金モデルを含むレートカード プランを作成します。料金は、最初のバンドル（最大 1,000 件の取引）が $50、2 番目のバンドル（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