料金表プランを構成する

現在、Apigee Edge のドキュメントを表示しています。
Apigee X のドキュメントをご確認ください。 情報

はじめに

料金表プランでは、トランザクションごとにデベロッパーに課金されます。このタイプのプランでは、課金モデルや課金モデルの料金など、追加の詳細を指定する必要があります。

オプションとして、（API パッケージではなく）個々のプロダクトのフリーミアム プランを指定できます。これは、プロダクト固有のプランに対してのみ指定できます。

定期的な料金が請求され、バンドルプランがリセットされるタイミングはいつですか？

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

プランの内容	不確実な状況
ゼロ以外の定期的な料金が月に設定されている ボリューム バンドプランまたはバンドル プラン	定期的な料金とバンドルプランのリセットは、毎月 1 日に行われます（デフォルト）。 毎月特定の日に繰り返すには、Management API を使用して料金プランを作成し、RecurringStartUnit プロパティでその日を指定します。API を使用した料金プランの作成をご覧ください。
ゼロ以外の定期的な料金が [週] に設定されていること。 ボリューム バンドプランまたはバンドル プラン	定期的な料金とバンドルプランのリセットは、デベロッパーの料金プランの開始日から 7 日ごとに行われます。
ゼロ以外の定期的な料金が [日] に設定される ボリューム バンドプランまたはバンドル プラン	定期的な料金とバンドルプランのリセットは、デベロッパーの料金プランの開始日から XX 日後に発生します。
定期的なお支払いがない（または料金が発生しない） ボリューム バンドプランまたはバンドル プラン	バンドルプランは、レート表で定義された集計ベースに基づいてリセットされます。たとえば、デベロッパーがその月の 19 日に料金プランを開始し、1 か月ごとの集計ベースである場合、バンドルの使用量は毎月 19 日にリセットされます。 日は必ずしも同じではありません。たとえば、料金プランが 12 月 31 に開始される場合、うるう年以外の 2 月は 28 日しかないため、リセット日は 28 日になります。その後、28 日はリセット日として続きます。

UI を使用して料金表プランを設定する

以下で説明するように、料金表プランを構成します。

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 トランザクションについて、1 トランザクションあたり $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

バンドルされている課金モデルの指定

バンドル型課金モデルでは、デベロッパーはトランザクションの「バンドル」に対して（または送信されたバイト数などのカスタム属性に基づいて）バンドルに対して（前払い）支払います。各バンドルのレートと集計ベース（デベロッパーがバンドルを使用できる期間）を指定します。

たとえば、2 つのバンドルを設定し、最初のバンドルサイズが 1 ～ 1, 000 トランザクション、2 つ目のバンドルサイズが 1, 001 ～ 2, 000 トランザクションであるとします。料金は最初のバンドルが $50、2 番目のバンドルが $40 で、集計基準は 1 です。最初のバンドルのレート表プランを購入したデベロッパーは、1 か月あたり 1, 000 件の取引に対して 50 ドル（前払い）を支払います。バンドル全体が使用されたかどうかにかかわらず、設定された金額がデベロッパーに請求されます。 集計期間が終了すると、プランは有効期限切れとなります。Bundle を再度使用する場合は、プラン（および Bundle）を再度購入する必要があります。

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

• 指定する各料金プランは、（ボリューム バンドではなく）バンドルのものです。
• 最後のバンドル内の無制限のトランザクションに対してデベロッパーに一定の金額を請求する場合を除き、最後のバンドルには上限を指定する必要があります。

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

たとえば、次の例では、バンドルされた課金モデルを含む料金表プランを作成します。レートは、最初のバンドル（最大 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