料金表プランを構成する

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

はじめに

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

必要に応じて、API パッケージではなく個々のプロダクトにフリーミアム プランを指定できます。これは、プロダクト固有のプランでのみ行えます。

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

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

プランに以下が含まれている場合:	...それが起こる
ゼロ以外の定期的な料金が [Month] に設定されている Volume Banded プランまたは Bundle プラン	定期的な料金とバンドルプランのリセットは毎月 1 日に行われます（デフォルト）。 特定の日に毎月繰り返す場合は、API を使用して料金プランを作成するで説明されているように、Management API を使用して料金プランを作成し、RecurringStartUnit プロパティでその日を指定します。
0 以外の定期的な料金が [週] に設定されている ボリュームバンドまたはバンドルのプラン	定期的な料金とバンドルプランのリセットは、デベロッパーの料金プランの開始日から 7 日ごとに行われます。
0 以外の定期的な料金が [日] に設定されている Volume Banded プランまたは Bundle プラン	定期的な料金とバンドルプランのリセットは、デベロッパーの料金プランの開始日から X 日ごとに行われます。
定期的な料金なし（または 0 ドル） ボリューム バンドまたはバンドルのプラン	バンドルプランは、料金カードで定義された集計ベースに基づいてリセットされます。たとえば、デベロッパーが料金プランを 19 日に開始し、集計ベースが 1 か月ごとの場合、バンドルの使用量は毎月 19 日にリセットされます。 ただし、日付は必ずしも同じとは限りません。たとえば、料金プランが 12 月 31 日に開始される場合、2 月は 28 日しかないため、リセット日はうるう年以外の 2 月 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 ドル（前払い）を支払います。デベロッパーには、バンドルが完全に使用されたかどうかにかかわらず、設定された金額が請求されます。集計期間が終了すると、プランは期限切れになります。デベロッパーがバンドルを再度使用する場合は、プラン（およびバンドル）を再度購入する必要があります。

料金プランの詳細で指定する内容は、基本的に、従量課金制の料金モデルの料金プランの詳細で指定する内容と同じです。相違点は次のとおりです。

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

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

たとえば、次のコードは、バンドルされた課金モデルを使用して料金プランを作成します。レートは、最初のバンドルには $50（最大 1,000 トランザクション）、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