パートナーシップAPIサブスクリプションオブジェクト

このドキュメントでは、 Partnership APIを使用して、元の料金モデルでアカウントのサブスクリプションを管理する方法について説明します。

要件

パートナーシップAPIは、New Relicの担当者から使用するように特に指示されていない限り、組織では利用できません。

サブスクリプションオブジェクトは、元の料金モデルを使用している場合にのみ使用できます。新しい使用量ベースの料金モデルのアカウントはサポートされていません。詳細については、 PartnershipAPIの要件をご覧ください。

Partnership APIでは、アカウントの個々の製品サブスクリプションをアップグレードまたはダウングレードすることはできません。代わりに、APIでは、アカウントのすべての製品サブスクリプションの構成を置き換える（追加する）必要があります。

製品構成が含まれていない場合、New Relic Partnership APIは、利用可能な最高の無料製品タイプでアカウントをプロビジョニングします。 APIは、アカウントのパートナーシップの構成とカスタム価格に基づいて製品レベルを自動的に選択します。

サブスクリプションオブジェクトの属性

これを使用する前に、まず要件をお読みください。

サブスクリプションオブジェクトの属性は次のとおりです。

タイプ：	整数
デフォルト：	（無し）

product ID属性は、このサブスクリプションに定義されているNewRelic製品を識別します。 Create呼び出しに必要です。

タイプ：	整数
デフォルト：	（無し）

製品レベルが無制限の場合でも、 Create呼び出しにはquantity属性が必要です。 APIは、New RelicAPMLiteなどの無制限の製品サブスクリプションに入力された数量値を無視します。

New Relic Insights、Browser、およびSyntheticsでは、事前定義された使用レベル（製品バケット）を特定する必要があります。これにより、APIは、選択した特定の数量に基づいて価格割引を適用できます。

識別する数量は、製品およびサブスクリプションレベルと完全に一致する必要があります。使用可能な製品バケットのリストについては、以下を参照してください。

タイプ：	弦
デフォルト：	（無し）

このサブスクリプションに関連するプロモーションコード。

PartnershipAPIのサブスクリプションエンドポイントではまだサポートされていません。ただし、アカウントAPIのCreate呼び出しを使用して、サブスクリプションの一部としてpromo_codeを渡すことができます。

製品のマッピング（product_id）

アカウント作成の呼び出しごとに、少なくとも1つのNewRelic製品タイプを提供する必要があります。 APIは、タイプの数値product_idのみを受け入れます。

重要

サブスクリプションオブジェクトは、元の料金モデルを使用しているアカウントにのみ適用されることに注意してください。

また、サーバーレス、ログ、トレースのサブスクリプションの作成は、PartnershipAPIではサポートされていません。アカウントにこれらのサブスクリプションがある場合、変更を行おうとするとエラーが返されます。サブスクリプションを変更するには、アカウントエグゼクティブにお問い合わせください。

重要

NewStartupおよびSmallBusinessのサービスプランは、New RelicPartnershipAPIでは利用できなくなりました。

アカウントごとに許可されるホストの数とデータ保持期間は、NewRelicAPMの料金体系内のサブスクリプションレベルによって異なります。たとえば、New Relic APMでは、Liteアカウントに許可されるホストの数に制限はありませんが、データ保持期間は24時間のみです。

さらに、価格設定とデータ保持は、ホストまたはコンピューティングユニット（CU）に基づいて価格設定モデルを選択するかどうかによって異なります。製品IDの整数形式を使用して、サブスクリプションレベルとプランのタイプを識別します。

APMサブスクリプションレベル	製品番号
Lite	1
標準	2
標準年次	3
プロ（ホスト）	4
プロアニュアル（ホスト）	5
企業	6
エンタープライズアニュアル	7
APM Essentials（ホスト）	8
APM Essentials Annual（ホスト）	9

計算単位（CU）に基づいて料金プランを選択する場合は、これらの製品ID整数形式を使用して、サブスクリプションレベルとプランのタイプを識別します。

APM Compute Units（CU）サブスクリプションレベル	製品番号
プロCU	26
プロアニュアルCU	27
APM Essentials CU	28
APM Essentials Annual CU	29

New Relic Mobileの料金体系では、エンタープライズサブスクリプションレベルでアカウントごとに月間アクティブユーザーが100,000人になります。データ保持はサブスクリプションレベルによって異なります。製品IDの整数形式を使用して、サブスクリプションレベルを識別します。

モバイルサブスクリプションレベル	製品番号
Lite	10
企業	13
エンタープライズアニュアル	14

New Relic Insightsは、保存される許容可能なイベントの数と関連するデータ保持ポリシーに基づいて料金体系を決定します（たとえば、Insights Freeのデータ保持は1日です）。 data_retention属性が必要であることに注意してください。

Insightsサブスクリプションレベル	製品番号
無料	15
なし	16
プロ	18
プロアニュアル	19

New Relic Browserの料金体系では、サブスクリプションレベルに関係なく、無制限の数のアプリユーザーが許可されます。ただし、1か月あたりの許容ページビュー数とデータ保持期間は、サブスクリプションレベルによって異なります。例えば：

Liteアカウントには、1か月あたりのページビュー数に制限がなく、24時間のデータ保持が含まれます。
プロアカウントの価格は、月額500,000ページビューと3か月のデータ保持から始まります。
製品IDの整数形式を使用して、サブスクリプションレベルを識別します。
ブラウザのサブスクリプションレベル
製品番号
Lite
20
プロ
21
プロアニュアル
22

ブラウザのサブスクリプションレベル	製品番号
Lite	20
プロ	21
プロアニュアル	22

合成モニタリングの料金体系では、許容されるモニタリングチェックのデフォルト数とデータ保持期間はサブスクリプションレベルによって異なります。製品IDの整数形式を使用して、サブスクリプションレベルを識別します。

Syntheticsサブスクリプションレベル	製品番号
Lite	23
プロ	24
プロアニュアル	25

ヒント

以前に非推奨のPartnership可用性監視APIを使用していた場合は、合成監視APIを使用してチェックをプロビジョニングし、 REST APIを使用してアラートをプロビジョニングし、顧客へのアラート通知を作成できます。

New Relicのインフラストラクチャの料金体系では、デフォルトのインスタンス数とデータ保持期間はサブスクリプションレベルによって異なります。インフラストラクチャイベントは、Insightsでクエリを実行できますが、NewRelicInsightsのクォータにはカウントされません。

New Relic Infrastructureは、コンピューティングユニット（CU）のみに基づく料金プランを提供します。製品IDの整数形式を使用して、サブスクリプションレベルを識別します。

インフラストラクチャサブスクリプションレベル	製品番号
インフラストラクチャなし	31
インフラストラクチャプロ（CU）	32
インフラストラクチャプロアニュアル（CU）	33
インフラストラクチャエッセンシャル（CU）	34
インフラストラクチャエッセンシャルアニュアル（CU）	35

サブスクリプションAPI呼び出し

これを使用する前に、まず要件をお読みください。

サブスクリプション関連のAPI関数のURLパターンは次のとおりです。使用する場合は、JSONオブジェクトとPartnerAPIキーを含むHTTPヘッダーと一緒に送信します。例えば：

GET .../api/v2/partners/PARTNER_ID/accounts/ACCOUNT_ID/subscriptions
x-api-key:PARTNER_ACCOUNT_KEY
Content-Type: application/json

{ JSON data }

電話	リソースのURLパターン
アカウントのすべてのサブスクリプションを一覧表示（インデックス付け）します。	`GET /api/v2/partners/PARTNER_ID/accounts/ACCOUNT_ID/subscriptions`
アカウントのサブスクリプションを表示します。	`GET /api/v2/partners/PARTNER_ID/accounts/ACCOUNT_ID/subscriptions/ID`
現在のサブスクリプションレベルを新しいサブスクリプションに置き換えます。	`POST /api/v2/partners/PARTNER_ID/accounts/ACCOUNT_ID/subscriptions`

サブスクリプションAPIの例

アカウントの元の価格設定モデルサブスクリプションとJSON応答リストサブスクリプションを作成するためのAPI呼び出しの例を次に示します。

{
  "id": 1069012,
  "starts_on": "2016-05-16",
  "expires_on": null,
  "annual_renewal_on": null,
  "products": [
  {
    "product_id": 4,
    "name": "Pro",
    "units": 2,
    "price": 218.0
  },
  {
    "product_id": 13,
    "name": "Mobile Enterprise",
    "units": 2,
    "price": 1500.0
  },
  {
    "product_id": 20,
    "name": "Browser Lite",
    "units": 0,
    "price": 0.0
  },
  {
    "product_id": 15,
    "name": "Insights Free",
    "units": 0,
    "price": 0.0
  },
  {
    "product_id": 23,
    "name": "Synthetics Lite",
    "units": 0,
    "price": 0.0
  },
  {
    "product_id": 31,
    "name": "Infrastructure None",
    "units": 0,
    "price": 0.0
  }
  ]
}

API呼び出しが返す可能性のある元の価格設定モデルのサブスクリプションステータス値を次に示します。

サブスクリプションステータス	説明
`pending`	顧客はNewRelic製品にサインアップしましたが、支払いを処理する必要があります。
`authorized`	クレジットカードが承認され、ボールトキーが保存されましたが、支払いは取得されていません。
`free`	このサブスクリプションは、無料のNewRelic製品用です。それ以上の処理は必要ありません。
`paid`	支払いが取得され、次の支払い日が設定されました。
`payment_declined`	支払いを承認する最後の試みは失敗しました。
`canceled`	New Relicアカウントにはアクティブなサブスクリプションがなく、アクティブではありません。支払いは承認または取得されるべきではありません。
`replaced`	このサブスクリプションは、別のNewRelicサブスクリプションに置き換えられました。

APIの例（v2）

これは、元の価格設定モデルのサブスクリプションを一覧表示、表示、作成、および更新するためのAPIサンプルリクエストとレスポンスです。応答の改行は読みやすさのためです。実際の応答は実線で表示されます。

リクエスト：

curl -X GET \
     -H 'x-api-key:PARTNER_ACCOUNT_KEY' \
     -H 'Content-Type:application/json' \
     https://rpm.newrelic.com/api/v2/partners/PARTNER_ID/accounts/ACCOUNT_ID/subscriptions

応答：

{
  "subscriptions": [
  {
    "id": :SUBSCRIPTION_ID,
    "starts_on": "2016-05-16",
    "expires_on": null,
    "annual_renewal_on": null,
    "products": [
    {
      "product_id": 1,
      "name": "Lite",
      "units": 0,
      "price": 0.0
    },
    {
      "product_id": 10,
      "name": "Mobile Lite",
      "units": 0,
      "price": 0.0
    },
    {
      "product_id": 20,
      "name": "Browser Lite",
      "units": 0,
      "price": 0.0
    },
   {
      "product_id": 16,
      "name": "Insights None",
      "units": 0,
      "price": 0.0
    },
    {
      "product_id": 23,
      "name": "Synthetics Lite",
      "units": 0,
      "price": 0.0
  },
  {
    "product_id": 31,
    "name": "Infrastructure None",
    "units": 0,
    "price": 0.0
  }
  ]
}

リクエスト：

curl -X GET \
     -H 'x-api-key:PARTNER_ACCOUNT_KEY' \
     -H 'Content-Type:application/json' \
     https://rpm.newrelic.com/api/v2/partners/PARTNER_ID/accounts/ACCOUNT_ID/subscriptions/SUBSCRIPTION_ID

応答：

{
  "id": :SUBSCRIPTION_ID,
  "starts_on": "2016-05-16",
  "expires_on": null,
  "annual_renewal_on": null,
  "products": [
  {
    "product_id": 1,
    "name": "Lite",
    "units": 0,
    "price": 0.0
  },
  {
    "product_id": 10,
    "name": "Mobile Lite",
    "units": 0,
    "price": 0.0
  },
  {
    "product_id": 20,
    "name": "Browser Lite",
    "units": 0,
    "price": 0.0
  },
  {
    "product_id": 16,
    "name": "Insights None",
    "units": 0,
    "price": 0.0
  },
  {
    "product_id": 23,
    "name": "Synthetics Lite",
    "units": 0,
    "price": 0.0
  },
  {
    "product_id": 31,
    "name": "Infrastructure None",
    "units": 0,
    "price": 0.0
  }
  ]
}

これは、Partnership APIを使用して、アカウントの新しいサブスクリプションを作成する（すべての製品の既存のサブスクリプションレベルを置き換える）方法の例です。

リクエスト：

curl -X POST \
     -H 'x-api-key:PARTNER_ACCOUNT_KEY' \
     -H 'Content-Type:application/json' \
     -d '{"subscriptions":[{"product_id":"1", "quantity":1}]}' \
     https://rpm.newrelic.com/api/v2/partners/PARTNER_ID/accounts/ACCOUNT_ID/subscriptions

応答：

{
  "id": 1069068,
  "starts_on": "2016-05-16",
  "expires_on": null,
  "annual_renewal_on": null,
  "products": [
  {
    "product_id": 1,
    "name": "Lite",
    "units": 0,
    "price": 0.0
  },
  {
    "product_id": 10,
    "name": "Mobile Lite",
    "units": 0,
    "price": 0.0
  },
  {
    "product_id": 20,
    "name": "Browser Lite",
    "units": 0,
    "price": 0.0
  },
  {
    "product_id": 16,
    "name": "Insights None",
    "units": 0,
    "price": 0.0
  },
  {
    "product_id": 23,
    "name": "Synthetics Lite",
    "units": 0,
    "price": 0.0
  },
  {
    "product_id": 31,
    "name": "Infrastructure None",
    "units": 0,
    "price": 0.0
  }
  ]
}

この機械翻訳は、参考として提供されています。

パートナーシップAPIサブスクリプションオブジェクト

要件

サブスクリプションオブジェクトの属性

product_id（新規サブスクリプションに必要）

数量（新規サブスクリプションに必要）

プロモーションコード

data_retention（Insightsサブスクリプションにのみ必要）

製品のマッピング（product_id）

重要

重要

APM

モバイル

インサイト

ブラウザ

シンセティックス

ヒント

インフラストラクチャー

サブスクリプションAPI呼び出し

サブスクリプションAPIの例

サブスクリプションオブジェクトの例

JSON応答の例

サブスクリプションステータス

APIの例（v2）

リスト

公演

新規作成（既存のサブスクリプションを置き換える）

この機械翻訳は、参考として提供されています。

パートナーシップAPIサブスクリプションオブジェクト

要件 .css-21sua1{background:none;border:none;width:0;padding:0;}

サブスクリプションオブジェクトの属性

数量（新規サブスクリプションに必要）

プロモーションコード

data_retention（Insightsサブスクリプションにのみ必要）

製品のマッピング（product_id）

重要

重要

APM

モバイル

インサイト

ブラウザ

シンセティックス

インフラストラクチャー

サブスクリプションAPI呼び出し

サブスクリプションAPIの例

サブスクリプションオブジェクトの例

JSON応答の例

サブスクリプションステータス

APIの例（v2）

リスト

公演

新規作成（既存のサブスクリプションを置き換える）

要件