料金のみのプランの詳細を指定する

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

はじめに

料金のみのプランでは、デベロッパーは料金プランで指定された API プロバイダの料金(1 回限りの設定料金や解約手数料など)のみを支払います。(料金プランで料金を指定する方法については、料金プランに料金を追加するをご覧ください)。取引に関連する追加料金はかかりません。

プランを作成するときに、必要に応じて更新期間を指定できます。収益化では、更新期間の終了時にプランが自動的に更新されます(デベロッパーがプランを解約しない限り)。デベロッパーが更新期間の前に料金プランを解約し、早期解約料金が適用されている場合、そのデベロッパーに料金が請求されます。

ツールボックス

料金のみのプランの詳細は、Monetization API を使用して追加します。これを行うには、/organizations/{org_name}/monetization-packages/{package_id}/rate-plans リソースの呼び出し(料金プランを作成するとき)で、リクエスト本文に関連するプロパティを設定します。

API を使用して料金のみのプランの詳細を指定する

料金のみのプランの詳細は、料金プランを作成するときに指定します。詳細は、呼び出しのリクエスト本文で指定します。

たとえば、次のコマンドでは、手数料のみの料金プランを作成します。このプランには、解約手数料(20 米ドル)、セットアップ料金(10 米ドル)、定期料金(月額 5 米ドル)が規定されています。料金は 30 日以内に支払う必要があります。また、定期的な料金は全額支払う必要があります(つまり、案分されません)。更新期間は 6 か月です。(料金関連の仕様と更新期間の仕様がハイライト表示されています)。

$ curl -H "Content-Type:application/json" -X POST -d \
'{
     "name": "Standard fees only plan",
     "advance": "false",
     "contractDuration": "6",
     "contractDurationType": "MONTH",
      "currency": {
      "id" : "usd"
     },
     "earlyTerminationFee": "20",
     "description": "Standard fees only plan",
     "displayName": "Standard fees only plan",
     "frequencyDuration": 1,
     "frequencyDurationType": "MONTH",
     "monetizationPackage": {
      "id": "location"
     },
     "organization": {
      "id": "{org_name}"
     },
     "prorate": "false",
     "paymentDueDays": "30",
     "published": "true",  
     "ratePlanDetails": [],   
     "recurringFee": "5",
     "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

ratePlanDetails プロパティが空になっていることに注意してください。料金のみの料金プランの場合、料金と更新期間以外の詳細情報はありません。

レスポンスは次のようになります(レスポンスの一部のみが表示されます)。
{
  "advance" : false,
  "contractDuration" : 6,
  "contractDurationType" : "MONTH",
  "currency" : {    
    "id" : "usd",
    "name" : "USD",
    ...
    "organization" : {
      ...
    },
    ...
  },
  "description" : "Standard fees only plan",
  "displayName" : "Standard fees only plan",
  "earlyTerminationFee" : 20,
  "freemiumDuration" : 0,
  "freemiumDurationType" : "MONTH",
  "freemiumUnit" : 0,
  "frequencyDuration" : 1,
  "frequencyDurationType" : "MONTH",
  "id" : "location_standard_fees_only_plan",
  "monetizationPackage" : {
    "description" : "Location",
    "displayName" : "Location",
    "id" : "location",
    "name" : "Location",
    "organization" : {
      ...
    },
    "product" : [ {
      "customAtt1Name" : "user",
      "description" : "Location",
      "displayName" : "Location",
      "id" : "location",
      "name" : "location",
      "organization" : {
        ...
    "status" : "CREATED"
  },
  "name" : "Standard fees only plan",
  "organization" : {
    ...
  },
  "paymentDueDays" : "30",
  "prorate" : false,
  "published" : false,
  "ratePlanDetails" : [ ],
  "recurringFee" : 5,
  "recurringStartUnit" : 1,
  "recurringType" : "CALENDAR",
  "setUpFee" : 10,
  "startDate" : "2013-07-30 00:00:00",
  "type" : "STANDARD"
}

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

次のステップ

必要に応じて、フリーミアム プランを追加します。フリーミアム プランを追加するをご覧ください。

料金プランを作成して料金プランの詳細を指定したら、プランを公開するか、下書きとして保存できます。詳しくは、料金プランの管理と公開をご覧ください。