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

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

はじめに

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

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

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

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

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

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

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

Edge

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

  1. [料金プラン] ページで、将来の料金プランを作成する料金プランに関連付けられている行にカーソルを合わせます。
    料金プランには、終了日を指定する必要があります。
  2. [+Future] をクリックします。
  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(プライベート クラウド)

Classic Edge UI を使用して、今後開始される料金プランの今後のバージョンを Classic Edge UI を使用して作成するには、次の手順を行います。

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

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

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

  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 パッケージの 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