Partnership API child account object

This doc explains how to use the Partnership API to manage child accounts. For accounts, you'd use the child account object.

Requirements

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

You may not have access to using this object. Before using the Partnership API, first read the requirements.

Introduction to using child accounts

Some notes about using the child account object:

To manage existing parent accounts or child accounts, use the Partnership API account object.
A parent account may have more than one associated child account, but every chld account must correspond to one and only one parent account.
Every child account must have at least a primary_admin user.
You cannot create a child account without connecting it to an existing parent account and adding at least one user.

Child account object attributes

Before using the Partnership API, first read the requirements.

Here are the Partnership API child account object's attributes:

Type:	String
Default:	(none)

This name must be unique in New Relic's database. If the specified name is not unique, it will be auto-incremented with a numeric suffix as follows:

conflicting_name_1
conflicting_name_2
etc.

Type:	Boolean
Default:	False

Use this flag to indicate a test account. Test accounts are assumed to contain garbage data and are ignored by internal systems. The data they generate may be deleted at any time.

Type:	Array
Default:	(none)

An array defining a list of users. There are some restrictions in place dependent on the status of your account:

For customer partnerships who have switched to the New Relic One user model: do not define users. If you add users with this field, they will be ignored. Instead, to add users, you'd use these user management procedures.
For all other accounts, which have users on our original user model: When you create the child account, you can define only one user: the account Owner. To add additional users, use the Partnership API user object.

For more about restrictions, read the Requirements.

For some New Relic organizations, child accounts can also be created via the parent account's Account settings page in the New Relic UI.

Child account API calls

Here is the URL pattern to create child accounts. Notice that the Parent Account ID must be specified. If using this URL pattern, send the JSON object along with an HTTP header containing the Partner API key. For example:

POST .../api/v2/partners/PARTNER_ID/accounts/PARENT_ACCOUNT_ID/sub_accounts
x-api-key:PARTNER_ACCOUNT_KEY
Content-Type: application/json

{ JSON data }

Call	Resource URL pattern
Create a child account with the given parameters.	`POST /api/v2/partners/PARTNER_ID/accounts/PARENT_ACCOUNT_ID/sub_accounts`

JSON example

Here is an example of a JSON request and response using the Partnership API child account object.

Note that this is just an example, and that for some accounts, the users attribute is unnecessary and will be ignored.

{
  "account": {
    "name": "Sample child account",
    "users": [
      {
        "email": "sample_user@sample.org",
        "password": "XXXXXXXX",
        "owner": true,
        "role": "admin",
        "first_name": "Sample",
        "last_name": "User"
      }
    ],
    "allow_api_access": true,
    "phone_number": "555-555-5555"
  }
}

{
  "id": XXXXXX,
  "name": "Sample Account",
  "status": "pending",
  "license_key": "XXXXXX",
  "api_key": "XXXXXX",
  "browser_monitoring_key": "XXXXXX",
  "allow_api_access": true,
  "high_security": false,
  "testing": null,
  "partner_external_identifier": null,
  "parent_account_id":XXXXXX,
  "subscription": {
    "id": XXXXXX,
    "starts_on": "2016-05-17",
    "expires_on": null,
    "annual_renewal_on": null,
    "products": [
      {
        "product_id": 4,
        "name": "Pro",
        "units": 10,
        "price": 1990.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
      }
    ]
  },
  "primary admin": {
    "id": XXXXXX,
    "email": "sample_user@sample.org",
    "first_name": "Sample",
    "last_name": "User",
    "state": "active"
  }
}

Child account object API examples

Here is an example of an API call using the Partnership API child account object.

Note that this is just an example, and that for some accounts, the users attribute is unnecessary and will be ignored.

Request:

curl -X POST \
-H 'x-api-key:PARTNER_ACCOUNT_KEY' \
-H 'Content-Type:application/json' \
-d '{"sub_account":{"name":"Sample child account"}, "users":[{"email":"sample_user@sample.org", "password":"XXXXXX", "first_name":"Sample", "last_name":"User", "role":"admin", "owner":"true"}]}' \
https://rpm.newrelic.com/api/v2/partners/PARTNER_ID/accounts/PARENT_ACCOUNT_ID/sub_accounts

Response (line breaks are for readability):

{
  "id": XXXXXX,
  "name": "Sample child account",
  "status": "pending",
  "license_key": "XXXXXX",
  "api_key": "XXXXXX",
  "browser_monitoring_key": "XXXXXX",
  "allow_api_access": false,
  "high_security": false,
  "testing": null,
  "partner_external_identifier": null,
  "parent_account_id":XXXXXX,
  "subscription": {
    "id": XXXXXX,
    "starts_on": "2016-05-17",
    "expires_on": null,
    "annual_renewal_on": null,
    "products": [
      {
        "product_id": 4,
        "name": "Pro",
        "units": 10,
        "price": 1999.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
      }
    ]
  },
  "primary admin": {
    "id": XXXXXX,
    "email": "sample_user@sample.org",
    "first_name": "Sample",
    "last_name": "User",
    "state": "active"
  }
}

Requirements

Introduction to using child accounts

Child account object attributes

name (REQUIRED)

allow_api_access

testing

users (REQUIRED for some accounts)

password (REQUIRED)

Child account API calls

JSON example

Child account object JSON request

JSON response

Child account object API examples

Create