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

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

はじめに

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

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

現在の料金プランの終了日が設定されていない場合、既存の料金プランを、開始日が本日以降の料金プランに置き換えることができます。公開料金プランを期限切れにするで説明されているように、現在の料金プランを期限切れにする必要があります。

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

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

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

以下で説明するように、将来の料金プランを作成します。

エッジ

Edge UI を使用して、本日より後に開始する料金プランの将来のバージョンを作成するには、次の手順を行います。

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

    料金プランの名前。

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

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

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

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

    : 一括販売のすべてのプロダクトを構成してください。

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

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

    ドラフトの公開 プランを公開します。

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

従来の Edge(Private Cloud)

Classic Edge UI を使用して、本日より後に開始する料金プランの将来のバージョンを作成するには、次の手順を行います。

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

    将来の料金プラン期間が開きます。

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

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

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

API を使用して /organizations/{org_name}/monetization-packages/{package_id}/rate-plans/{plan_Id}/revisionPOST リクエストを発行することにより、将来の料金プランを作成できます。

ここで

  • {org_id} は組織の名前です。
  • {package_id} は API パッケージの ID です。
  • {plan_Id} は料金プランの 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