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

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

要件

The Partnership API is not available to your organization unless you're specifically instructed by your New Relic representative that you should use it.

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

パートナーシップ API では、アカウントの個々の製品サブスクリプションをアップグレードまたはダウングレードすることはできません。代わりに、 API 、アカウントの all 製品サブスクリプションの設定を置き換える (追加する) 必要があります。

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

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

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

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

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

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

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

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

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

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

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

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

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

製品のマッピング（product_id）

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

重要

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

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

重要

新しいStartupおよびSmall Businessサービスプランは、New Relic Partnership API を通じて利用できなくなりました。

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

また、料金とデータ保持期間は、ホストベースの料金モデルを選択するか、コンピュートユニット (CU) ベースの料金モデルを選択するかによって異なります。サブスクリプションレベルとプランの種類を識別するには、製品 ID のinteger形式を使用します。

APM subscription level	Product ID
Lite	1
標準	2
標準年次	3
プロ（ホスト）	4
プロアニュアル（ホスト）	5
企業	6
エンタープライズアニュアル	7
APM Essentials（ホスト）	8
APM Essentials Annual（ホスト）	9

コンピュートユニット (CU) に基づいて料金プランを選択する場合は、これらの製品 ID integer形式を使用して、サブスクリプションレベルとプランの種類を識別します。

APM Compute Units (CU) subscription level	Product ID
プロCU	26
プロアニュアルCU	27
APM Essentials CU	28
APM Essentials Annual CU	29

New Relic Mobileの価格体系では、エンタープライズサブスクリプションレベルでアカウントあたり月間 100,000 人のアクティブユーザーが許可されます。データ保持期間はサブスクリプションレベルによって異なります。サブスクリプションレベルを識別するには、製品 ID のinteger形式を使用します。

Mobile subscription level	Product ID
Lite	10
企業	13
エンタープライズアニュアル	14

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

Insights subscription level	Product ID
無料	15
なし	16
プロ	18
プロアニュアル	19

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

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

Browser subscription level	Product ID
Lite	20
プロ	21
プロアニュアル	22

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

Synthetics subscription level	Product ID
Lite	23
プロ	24
プロアニュアル	25

ヒント

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

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

New Relic Infrastructureコンピュートユニット (CU) のみに基づいた料金プランを提供します。サブスクリプションレベルを識別するには、製品 ID のinteger形式を使用します。

Infrastructure subscription level	Product 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パターン
List (インデックス) アカウントのすべてのサブスクリプション。	`GET /api/v2/partners/PARTNER_ID/accounts/ACCOUNT_ID/subscriptions`
Show アカウントのサブスクリプション。	`GET /api/v2/partners/PARTNER_ID/accounts/ACCOUNT_ID/subscriptions/ID`
Replace 現在のサブスクリプションレベルを新しいサブスクリプションに変更します。	`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呼び出しが返す可能性のある元の価格設定モデルのサブスクリプションステータス値を次に示します。

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

APIの例（v2）

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

Request:

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

Response:

{
  "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
  }
  ]
}

Request:

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

Response:

{
  "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を使用して、アカウントの新しいサブスクリプションを作成する（すべての製品の既存のサブスクリプションレベルを置き換える）方法の例です。

Request:

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

Response:

{
  "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）

リスト

公演

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

要件