将来の料金プランを作成する

ここに表示されているのは Apigee Edge のドキュメントです。
Go to the Apigee X のドキュメントに移動します
info

はじめに

既存の料金プランを公開した後で変更できるプロパティは、終了日のみです。 ただし、変更された料金プランの料金など、 変更されたプロパティを含むプランの新しいバージョンを作成できます。リビジョンは、将来の日付に有効になるように設定できます。リビジョンが有効になると、元の料金プランは終了します。

たとえば、2019 年 12 月 31 日に有効期限が切れる標準料金プランを作成し、 2020 年 1 月 1 日に有効になる別のプランに置き換えるとします。これを行うには、 将来の料金プランを作成し、2020 年 1 月 1 日に有効になるように設定します。

現在の料金プランに終了日が設定されていない場合は、既存の料金プランを、 今日から開始する将来の料金プランに置き換えることができます。公開料金プランを失効させるの説明に従って、現在の料金プランを失効させる必要があります。

デベロッパーには、改訂された料金プランが通知されます。元の料金プランに同意したデベロッパーは、リビジョンに自動的に登録されます(リビジョンを拒否することもできます)。

将来の料金プランは、以下のセクションで説明するように、管理 UI または収益化 API を使用して作成できます。

UI を使用して将来の料金プランを作成する

将来の料金プランを作成する手順は次のとおりです。

エッジ

Edge UI を使用して、今日以降に開始する料金プランの将来のバージョンを作成する手順は次のとおりです。

  1. [料金プラン] ページで、 将来の料金プランを作成する料金プランに関連付けられた行にカーソルを合わせます。
    料金プランには終了日が必要です。
  2. [+将来] をクリックします。
  3. [将来の料金プラン] セクションで、次のいずれかを選択します。
    • 新しい有効日から契約期間全体を再開する: 将来の料金プランは有効日から 有効になります。将来の料金プランの更新期間は、 現在の料金プランと同じです。
    • 有効日から、以前の契約期間を新しい期間から差し引く: 将来の料金プランは有効日から有効になります。現在の料金プランの使用期間は、将来の料金プランの更新期間から差し引かれます。つまり、デベロッパーが現在のプランを 3 か月間使用すると、更新期間が 3 か月短縮されます。
  4. 上部のパネルで次のフィールドを構成します。
    : その他のフィールドは読み取り専用です。
    フィールド 説明 デフォルト 必須
    料金プラン名

    料金プランの名前。

    : 名前は元の料金プラン名と一致する必要はありません。

    既存のプラン名 はい
    開始日 料金プランが有効になる日付。開始日を入力するか、カレンダーを使用して日付を選択します。 今日 ×
    終了日 料金プランが終了する日付。終了日を指定するには、[終了日を設定] 切り替えスイッチを有効にして、終了日を入力するか、カレンダーを使用して日付を選択します。

    : 料金プランは、指定した日付の終日 まで有効です。たとえば、2018 年 12 月 1 日に料金プランの有効期限を終了する場合は、endDate 値を 2018-11-30 に設定します。この場合、料金プランは 2018 年 11 月 30 日の終日に有効期限が切れます。2018 年 12 月 1 日のリクエストはすべてブロックされます。

    なし ×
    ポータルに表示 料金プランを公開するか非公開にするかを設定します。公開料金プランと非公開レートをご覧ください。 有効 ×
  5. 料金プランの料金を構成します。料金の構成をご覧ください。
    : 調整可能な通知プランには適用されません。
  6. 複数の API プロダクトを含むプロダクト バンドルを選択した場合は、[特定の料金プランまたは汎用料金プラン] セクションで次の設定を行います。
    []: この手順は、調整可能な通知プランには適用されません。
    フィールド 説明 デフォルト
    各プロダクトを個別に構成する API プロダクトごとに個別の料金プランを構成するかどうかを指定するフラグ。 無効
    各プロダクトのフリーミアム オファーを個別に構成する API プロダクトごとにフリーミアム プランを構成するかどうかを指定するフラグ。 無効
    プロダクトを選択する 一方または両方のフラグを有効にした場合は、プルダウン リストから各プロダクトを個別に選択し、料金プランの詳細を構成する必要があります。

    : プロダクト バンドル内のすべてのプロダクトを構成してください。

    該当なし
  7. 選択した料金プランのタイプに基づいて、料金プランの詳細を構成します。
  8. 次のいずれかをクリックします。
    ボタン 説明
    下書きを更新 料金プランを下書きとして保存します。

    料金プランは、公開するまでアプリ デベロッパーに表示されません。下書きの料金プランのフィールドは編集できます。

    [**下書きを公開**] プランを公開します。

    : 料金プランを公開した後で、終了日がまだ設定されていない場合にのみ、終了日を変更できます。料金プランを公開した後に削除することはできませんが、公開料金プランを失効させるの説明に従って、料金プランを失効させて将来の料金プランに置き換えることができます。

Classic Edge(Private Cloud)

Classic Edge UI を使用して、今日以降に開始する料金プランの将来のバージョンを作成する手順は次のとおりです。

  1. パッケージ カタログで、置き換える料金プランの [下書き/将来] 列にある [**+将来**] をクリックします。

    [将来の料金プラン] ウィンドウが開きます。

    将来の料金プラン ウィンドウと現在の料金プラン ウィンドウの主な違いは、 [既存のサブスクライバー] セクションが追加されていることです。

  2. 他の料金プランと同様に、次の操作を行います。
    • [料金プラン名] フィールドにプランの名前を入力します。名前は元の料金プランの名前と一致する必要はありません。
    • 料金プランの料金を構成します(省略可)。
    • 選択した料金プランのタイプに基づいて、料金プランの詳細を構成します。
    • 将来のプランが有効になる日付(料金プランの公開を参照)と終了日を指定します(将来の料金プランを特定の日付に終了しない場合は、[終了日なし] を選択することもできます)。現在のプランに終了日が設定されている場合、 将来のプランの有効日は現在のプランの終了日より後の日付にする必要があります。
  3. [既存のサブスクライバー] セクションで、次のいずれかを選択します。
    • 新しい発効日から契約期間全体を再開する。将来の料金プランは 有効日から有効になります。将来の料金プランの更新期間は、 現在の料金プランと同じです。
    • 発効日から、以前の契約期間を新しい期間から差し引く。将来の料金プランは有効日から有効になります。現在の料金プランの使用期間は、将来の料金プランの更新期間から差し引かれます。つまり、デベロッパーが現在のプランを 3 か月間使用すると、更新期間が 3 か月短縮されます。
  4. [有効日] フィールドに、既存の料金プランの終了日より後の開始日を入力します。

API を使用して将来の料金プランを作成する

API を使用して将来の料金プランを作成するには、POST リクエストを /organizations/{org_name}/monetization-packages/{package_id}/rate-plans/{plan_Id}/revision に送信します。

ここで

  • {org_id} は組織の名前です。
  • {package_id} は API パッケージの識別子です。
  • {plan_Id} は料金プランの識別子です。
リビジョンを作成するときは、リクエストの本文で次のプロパティを指定する必要があります。
  • parentRatePlan は、元の料金プランの ID を指定します。
  • startDate は、新しいプランが有効になる日付を指定します。

将来の料金プランの名前は、元のプランの名前と一致させることはできません。また、すべての料金プランで一意である必要があります。デベロッパー向けに元の開始日を記録する場合は、keepOriginalStartDate フラグを true に設定します。このフラグ のデフォルトはfalseです。

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

たとえば、次のリクエストでは将来の料金プランが作成されます。

$ curl -H "Content-Type:application/json" -X POST -d \
'{ 
     "parentRatePlan": {
       "id": "monetization_package_flat_rate_card_plan_1379513833409"
     },
     "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": "myorg"
      },
      "ratePlanRates": [
       {
        "type": "RATECARD",
        "rate": "0.05",
        "startUnit": "0"       
       }      
      ],     
     "ratingParameter": "VOLUME",
     "type": "RATECARD"
     }],
     "recurringStartUnit": 1,
     "recurringType": "CALENDAR",
     "recurringFee": "10",
     "setUpFee": "10",
     "startDate": "2014-01-01 00:00:00",
     "type": "STANDARD"
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/location/rate-plans/monetization_package_flat_rate_card_plan_1379513833409/revision" \
-u email:password