現在、Apigee Edge のドキュメントを表示しています。
Apigee X のドキュメントをご確認ください。 情報
はじめに
料金表プランでは、トランザクションごとにデベロッパーに課金されます。このタイプのプランでは、課金モデルや課金モデルの料金など、追加の詳細を指定する必要があります。
オプションとして、(API パッケージではなく)個々のプロダクトのフリーミアム プランを指定できます。これは、プロダクト固有のプランに対してのみ指定できます。
定期的な料金が請求され、バンドルプランがリセットされるタイミングはいつですか?
料金プランには、定期的な料金と API バンドル(ボリューム バンドプランとバンドルプラン)を含めることができます。どちらも、料金が請求される特定のタイミングで、バンドルプランがゼロにリセットされます。次の表に、定期的な料金が請求され、バンドル数がリセットされるタイミングを示します。デベロッパー アプリが特定のトランザクション制限に達したために API 呼び出しをそれ以上ブロックされた場合、このタイミングで API 呼び出しの回数がゼロにリセットされ、アプリは再び呼び出しを開始できるようになります。
プランの内容 | 不確実な状況 |
---|---|
|
定期的な料金とバンドルプランのリセットは、毎月 1 日に行われます(デフォルト)。 毎月特定の日に繰り返すには、Management API を使用して料金プランを作成し、 |
|
定期的な料金とバンドルプランのリセットは、デベロッパーの料金プランの開始日から 7 日ごとに行われます。 |
|
定期的な料金とバンドルプランのリセットは、デベロッパーの料金プランの開始日から XX 日後に発生します。 |
|
バンドルプランは、レート表で定義された集計ベースに基づいてリセットされます。たとえば、デベロッパーがその月の 19 日に料金プランを開始し、1 か月ごとの集計ベースである場合、バンドルの使用量は毎月 19 日にリセットされます。 日は必ずしも同じではありません。たとえば、料金プランが 12 月 31 に開始される場合、うるう年以外の 2 月は 28 日しかないため、リセット日は 28 日になります。その後、28 日はリセット日として続きます。 |
UI を使用して料金表プランを設定する
以下で説明するように、料金表プランを構成します。
エッジ
料金表プランを構成するには、料金プランを作成または編集するときに、[レート表] または [レート表と収益分配率] の料金プランのタイプを選択し、[レート表] セクションで次のいずれかの課金モデルを選択します。
充電モデル | 説明 |
フラットレート | 取引ごとに固定料金がデベロッパーに請求されます。 |
ボリューム バンド | デベロッパーには、取引量に応じて変動料金が請求されます。 |
バンドル | 取引の一括販売ごとに、あらかじめ決められた金額がデベロッパーに請求されます。バンドル全体が使用されたかどうかにかかわらず、設定された金額がデベロッパーに請求されます。
注: レート表と収益分配率を選択している場合、このオプションは使用できません。 |
次に、選択した充電モデルに基づいて次の情報を構成します。
充電モデル | フィールド | 説明 |
すべて | 計算頻度 | トランザクション量(またはカスタム属性関連のボリューム)を計算する期間。月数(1 ~ 24 か月)を選択します。 |
フラットレート | 定額 | 取引ごとに請求される料金です。小数(小数第 4 位まで)を入力してください。
注: (UI ではなく)API を使用して請求される料金に指定できる小数点以下の桁数を構成できます。詳しくは、料金プラン料金の小数点以下の桁数を構成するをご覧ください。 たとえば、通貨が米国ドルで 0.10 を入力すると、トランザクションごとに $0.10 が課金されます(トランザクションで送信されたバイト数などのカスタム属性に基づく場合は、指定したバイト数の送信に対して $0.10 が課金されます)。 |
ボリューム バンド | 音量バンド | ボリューム バンド課金モデルの場合、1 つ以上のトランザクション量(または顧客属性ベース)のボリューム範囲(各範囲が「ボリューム バンド」)。各音量帯にレートを割り当てることができます。このレートは、該当する音量帯のすべての取引に適用されます。最初の周波数帯の上限を指定します(例: 最大 1,000)。下限は 0 より大きい値にプリセットされています。 バンドを追加するには [+New] をクリックします。 最終的な帯域の上限は、このレベルを超えるすべての取引を示すには空白のままにします。 注: (UI ではなく)API を使用して請求される料金に指定できる小数点以下の桁数を構成できます。詳しくは、料金プラン料金の小数点以下の桁数を構成するをご覧ください。 たとえば、[ボリューム バンド] セクションで 2 つのボリューム バンド(>0 ~ 1, 000 と 1, 000 以上)を指定した場合、0 ~ 1,000 超の音量帯に 0.15、1, 000 以上の音量帯に 0.10 と入力します。選択した通貨が米ドルの場合、最初の 1,000 トランザクションのレートは各トランザクションの $0.15 になり、1,000 を超えるトランザクションのレートは各トランザクションの $0.10 になります。 |
バンドル | API バンドルの料金 | バンドル内のトランザクションの数(または、バンドルで送信されたバイト数などのカスタム属性に関連する数)。各バンドルには価格を割り当てることができます。価格はバンドル全体に適用されます。最初のバンドルの上限を指定します(例: 最大 1,000)。下限は 0 より大きく設定されています。 [+ 新規] をクリックして、バンドルを追加します。最後のバンドル内の無制限のトランザクションに対してデベロッパーに一定の金額を請求する場合を除き、最後のバンドルの上限を指定する必要があります。 注: (UI ではなく)API を使用して請求される料金に指定できる小数点以下の桁数を構成できます。詳しくは、料金プラン料金の小数点以下の桁数を構成するをご覧ください。 たとえば、[Bundle Size] セクションで 2 つのバンドル(0 より大きい場合は 1,000 まで、1,000 より大きい場合は 2,000)を指定する場合、0 より大きい最大 1,000 バンドルには 50 を、1,000 ~ 2,000 のバンドルには 40 を入力できます。選択した通貨が米ドルの場合、1 つ目の一括販売の価格は $50、2 つ目の一括販売の価格は $40 です。バンドル内でのトランザクションの数に関係なく、該当するバンドル価格がデベロッパーに請求されます(つまり、バンドル内の最初の取引が完了するとすぐに、バンドル価格が請求されます)。 |
API プロダクトのカスタム属性を定義した場合、カスタム評価パラメータを設定すると、各トランザクション内のカスタム属性に基づいてアプリ デベロッパーに請求できます。たとえば、トランザクションごとにデベロッパーに請求するプランを設定する場合、トランザクションごとに異なる可能性があるバックエンドで送信されるバイト数などのカスタム属性に基づいて、プランの料金を設定できます。
この場合は、[カスタム評価パラメータを使用] を選択し、プルダウン リストからカスタム属性を選択します。詳細については、カスタム属性を使用して料金プランを構成するをご覧ください。
従来の Edge(Private Cloud)
Classic Edge UI を使用して料金表プランを構成するには:
- 手順に沿って料金プランを作成します。
- [料金プランタイプ] プルダウンで [レート表] を選択して、収益モデルを設定します。
- 選択した API パッケージに複数の API プロダクトが含まれている場合は、次のいずれかのオプションを選択します。
注: API パッケージに 1 つの API プロダクトが含まれている場合は、この手順を省略できます。
- プロダクト固有のプラン: API プロダクトごとに料金プランの詳細を個別に構成します。
- すべてのプロダクトの汎用プラン: すべての API プロダクトの料金プランの詳細を設定します。
- 汎用の料金プランまたは各 API プロダクト固有の料金プランの [レート表] をクリックします。
注: API プロダクト固有のプランを構成する場合は、API プロダクトごとにレート表のプランを構成する必要があります。
[レート表] ウィンドウが開きます。
- API プロダクトのフリーミアム プランを設定します。フリーミアム プランでは、一定期間、または使用量に応じて API プロダクトを無料で利用できます。
次の情報を入力します。
項目 説明 フリーミアム製品か? 無償期間の範囲。次のいずれかのラジオボタンを選択します。
- 数量別。無償期間は、[ボリューム] フィールドで指定された数量に基づきます。
- 期間別。料金期間は、[フリーミアム期間] フィールドで指定された期間に基づきます。
- 最初に来た方を選んでください。無料期間は、[ボリューム] フィールドの数量または [フリーミアム期間] フィールドの期間のいずれか早い方に達した時点で終了します。
- いいえ。これはフリーミアム プランではありません。これがデフォルトです。
フリーミアム数 デベロッパーへの請求が行われないトランザクションのボリューム(またはトランザクション記録ポリシーに記録されたカスタム属性に関するボリューム)。使用量は API プロダクトごとに測定されます。ボリューム番号を入力します(5000 など)。つまり、デベロッパーがプランを開始した場合、最初の 5,000 件のトランザクション(またはカスタム属性関連アイテムを最初の 5,000 件)については課金されません。このフィールドは、[Freemium Product?] フィールドで [By Quantity] または [いずれかの先着順] を選択した場合に限り有効になります。
フリーミアムの期間 デベロッパーに課金されない期間。数値を入力して期間(1 か月など)を選択します。つまり、デベロッパーは 1 か月間課金されません。このフィールドは、[フリーミアム プロダクト] で [期間別] または [最初に来た方] を選択した場合にのみ有効になります。
- 次のいずれかの充電モデルを選択します。
- 定額制。このモデルでは、トランザクションごとに固定料金がデベロッパーに請求されます。
- ボリューム バンド。このモデルでは、取引量に応じてデベロッパーに変動料金が請求されます。
- 一括販売。このモデルでは、取引のバンドルごとに一定額(前払い)がデベロッパーに請求されます。バンドル全体が使用されたかどうかにかかわらず、設定された金額がデベロッパーに請求されます。
定額モデルの場合: [汎用料金表] ウィンドウの [料金] セクションに次の情報を入力します。
項目 説明 運営者(または組織) 組織の名前。このフィールドは、組織プロファイルの演算子(または組織)フィールドの値を使用してプリセットされています。
国 組織の事業を運営している国。このフィールドは、組織プロファイルの [国] フィールドの値を使用してプリセットされています。
定額制 トランザクションごとに請求されるレート。小数(小数第 4 位まで)を入力してください。
注: (UI ではなく)API を使用して課金される料金に指定できる小数点以下の桁数を構成できます。詳しくは、料金プラン料金の小数点以下の桁数を構成するをご覧ください。
たとえば、通貨が米ドルで 0.10 を入力すると、トランザクションごとに $0.10 が課金されます(トランザクションで送信されたバイト数などのカスタム属性に基づく場合は、指定したバイト数の送信に対して $0.10 が課金されます)。
ボリューム バンドモデルの場合: [汎用料金表] ウィンドウには、集計の基準や「ボリューム バンド」(異なるレートを適用できるトランザクション量の範囲)を指定するフィールドが表示されます。
このタイプのプランは通常、音量の大きいバンドに割引料金を提供することで、デベロッパーがより多くの量を生成するよう促すことを目的としています。
[汎用料金表] ウィンドウに以下の情報を入力します。
項目 説明 集計ベース トランザクション量(またはカスタム属性関連のボリューム)を集計する期間。集計されたボリュームは、各トランザクションに適用するボリューム バンドとレートを識別するために使用されます。月数(1 ~ 12 か月)を選択します。
バンドルがリセットされるタイミングの詳細については、定期的な料金が請求されるタイミングとバンドル プランがリセットされるタイミングをご覧ください。
音量バンド 1 つ以上のトランザクション量(または顧客属性ベースの量)のボリューム(各範囲が「音量帯」)。各音量帯にレートを割り当てることができます(このレートは、[料金] セクションの [ボリューム バンド] フィールドで設定できます)。このレートは、該当する音量帯のすべてのトランザクションに適用されます。最初の帯域の上限を指定します(例: 最大 1,000)。下限は 0 より大きい値にプリセットされています。[+] をクリックすると、2 つ目の帯域を追加できます(例: 1, 000 超~ 2, 000)。周波数帯を追加するには [+] をクリックします。最終的な帯域の上限を空欄にすると、このレベルを超えるすべてのトランザクションを示すことができます。
料金 運営者(または組織) 組織の名前。このフィールドは、組織プロファイルの演算子(または組織)フィールドの値を使用して事前に設定されます。
国 組織の事業を運営している国。このフィールドは、組織プロファイルの [国] フィールドの値を使用してプリセットされています。
通貨 組織で使用する「基本」または会計通貨。このフィールドは、組織プロフィールの通貨フィールドの値を使用して事前に設定されていますが、ここで変更できます。
音量帯 音量帯のレート。音量帯ごとにレートを指定します。帯域ごとに 10 進数を入力します(小数点以下 4 桁まで)。
注: 音量帯域レートに指定できる小数点以下の桁数は、UI ではなく API を使用して構成できます。詳しくは、料金プラン料金の小数点以下の桁数を構成するをご覧ください。
たとえば、[ボリューム バンド] セクションで 2 つの音量帯域(0 ~ 1, 000 超と 1, 000 以上)を指定した場合、0 ~ 1,000 超の音量帯に 0.15、1, 000 以上の音量帯に 0.10 を入力できます。選択した通貨が米ドルの場合、最初の 1,000 トランザクションのレートは各トランザクションの $0.15 です。また、1,000 を超えるトランザクションのレートは各トランザクションの $0.10 になります。
バンドルモデルの場合: 汎用料金表ウィンドウには、集計の基準(デベロッパーがトランザクションのバンドルを使用できる期間)を指定したり、バンドルのサイズなどのバンドル関連情報を指定したりするための追加のフィールドが表示されます。
[汎用料金表] ウィンドウに以下の情報を入力します。
項目 説明 集計ベース デベロッパーがトランザクションのバンドル(またはカスタム属性ベースのバンドル)を使用できる期間。月数(1 ~ 12 か月)を選択します。この期間を過ぎるとプランの有効期限が切れるため、デベロッパーはプラン(およびバンドル)を再度購入する必要があります。
バンドルがリセットされるタイミングの詳細については、定期的な料金が請求されるタイミングとバンドル プランがリセットされるタイミングをご覧ください。
バンドルのサイズ バンドル内のトランザクションの数(またはバンドルで送信された総バイト数などのカスタム属性に関連する数)。各バンドルには価格を割り当てることができます([料金] セクションの [Bundle Size] フィールドで価格を設定します)。価格はバンドル全体に適用されます。最初のバンドルの上限を指定します(例: 最大 1,000)。下限は 0 より大きく設定されています。2 番目のバンドルを追加するには、[+] をクリックします(たとえば、1, 000 超から 2, 000 まで)。バンドルをさらに追加するには [+] をクリックします。最後のバンドル内の無制限のトランザクションに対してデベロッパーに一定の金額を請求する場合を除き、最後のバンドルには上限を指定する必要があります。
料金 運営者(または組織) 組織の名前。このフィールドは、組織プロファイルの演算子(または組織)フィールドの値を使用して事前に設定されます。
国 組織の事業を運営している国。このフィールドは、組織プロファイルの [国] フィールドの値を使用してプリセットされています。
通貨 組織で使用する「基本」または会計通貨。このフィールドは、組織プロフィールの通貨フィールドの値を使用して事前に設定されていますが、ここで変更できます。
一括販売サイズ(価格) セットの価格。セットごとに価格を指定します。小数(小数第 4 位まで)を入力してください。
注: バンドルレートに指定できる小数点以下の桁数は、UI ではなく API を使用して構成できます。詳しくは、料金プラン料金の小数点以下の桁数を構成するをご覧ください。
たとえば、[Bundle Size] セクションで 2 つのバンドル(0 より大きい場合は 1,000 まで、1,000 より大きい場合は 2,000)を指定する場合、0 より大きい最大 1,000 バンドルには 50 を、1,000 ~ 2,000 のバンドルには 40 を入力します。選択した通貨が米ドルの場合、最初のバンドルの価格は $50、2 番目のバンドルの価格は $40 です。バンドル内で使用するトランザクションの数に関係なく、該当するバンドル価格がデベロッパーに請求されます(つまり、バンドル内の最初の取引が完了するとすぐにバンドル料金が請求されます)。
- [適用して閉じる] をクリックしてレート表の詳細を保存し、標準料金プランのウィンドウに戻ります。
- 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 トランザクションについて、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