Account Management APIs

APIs for MSPs and Distributors to manage accounts

Note: These APIs only apply to distributors of MSP accounts. Most MSPs are able to manage companies via commander 'msp' commands.

Capabilities of the APIs

The primary use cases enabled via the API are:

Create Trial Account
Convert To Paid Account
List all MSPs
Get Current Usage
Get Monthly Usage
Cancel Paid Account
Activate Expired Accounts
List MSP Products
Delete Pending/Conflict Accounts

In order to access the MSP specific APIs, contact your support representative to request an API key, this will be shared as a secret key in a Keeper record.

API definitions

Convert to Paid

post

/convert-to-paid

convert-to-paid

Authorizations

AuthorizationstringRequired

JWT with HS512 alg

Header parameters

AuthorizationstringOptional

Bearer

vendorstringOptional

vendor_name(Provided by Keeper)

Body

Responses

200

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

post

/convert-to-paid

POST /bi_api/v1/services/mspvendor/convert-to-paid HTTP/1.1
Host: keepersecurity.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 29

{
  "vendorInternalId": "string"
}

{
  "success": true,
  "message": "Converted Trial to Paid"
}

Get Current Usage

post

/current-usage

Fetch Current Usage

Authorizations

AuthorizationstringRequired

JWT with HS512 alg

Header parameters

AuthorizationstringOptional

Bearer

vendorstringOptional

vendor_name(Provided by Keeper)

Body

Responses

200

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

post

/current-usage

POST /bi_api/v1/services/mspvendor/current-usage HTTP/1.1
Host: keepersecurity.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 29

{
  "vendorInternalId": "string"
}

{
  "success": true,
  "usage": {
    "mspItem": {
      "companyName": "msp",
      "companyId": "msp_partnerId",
      "invitedUsers": 0,
      "products": [
        {
          "productName": "basePlan",
          "productId": 720,
          "quantity": 1
        },
        {
          "productName": "addon",
          "productId": 916,
          "quantity": 1
        }
      ]
    },
    "mcItems": [
      {
        "companyName": "mc1",
        "companyId": "mc1_partnerId",
        "invitedUsers": 0,
        "maximumAllowedUsers": 11110,
        "plan": "Keeper Business Bundle",
        "products": [
          {
            "productName": "bundle",
            "productId": 10011,
            "quantity": 2
          },
          {
            "productName": "addon",
            "productId": 916,
            "quantity": 1.1
          }
        ]
      },
      {
        "companyName": "mc2",
        "companyId": "mc2_partnerId",
        "invitedUsers": 0,
        "maximumAllowedUsers": 1000,
        "plan": "Keeper Business Plus Bundle",
        "products": [
          {
            "productName": "bundle2",
            "productId": 10011,
            "quantity": 1.1
          },
          {
            "productName": "addon",
            "productId": 916,
            "quantity": 1.1
          }
        ]
      }
    ]
  }
}

Fetch Monthly Usage

post

/monthly-usage

Fetch Monthly Usage

Authorizations

AuthorizationstringRequired

JWT with HS512 alg

Header parameters

AuthorizationstringOptional

Bearer

vendorstringOptional

vendor_name(Provided by Keeper)

Body

Responses

200

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

post

/monthly-usage

POST /bi_api/v1/services/mspvendor/monthly-usage HTTP/1.1
Host: keepersecurity.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 56

{
  "vendorInternalId": "string",
  "month": "08",
  "year": "2021"
}

{
  "success": true,
  "usage": {
    "mspItem": {
      "companyName": "msp",
      "companyId": "msp_partner_id",
      "products": [
        {
          "productName": "basePlan",
          "productId": 720,
          "quantity": 1.1,
          "unitPrice": 2.54,
          "unit": "string",
          "avgMonthlyCost": 3.11
        },
        {
          "productName": "addon",
          "productId": 916,
          "quantity": 1.1,
          "unitPrice": 2.54,
          "unit": "string",
          "avgMonthlyCost": 3.11
        }
      ],
      "total": 2.54
    },
    "mcItems": [
      {
        "companyName": "mc1",
        "companyId": "mc1_partner_id",
        "products": [
          {
            "productName": "bundle",
            "productId": 720,
            "quantity": 1.1,
            "unitPrice": 2.54,
            "unit": "string",
            "avgMonthlyCost": 3.11
          },
          {
            "productName": "addon",
            "productId": 916,
            "quantity": 1.1,
            "unitPrice": 2.54,
            "unit": "string",
            "avgMonthlyCost": 3.11
          }
        ],
        "total": 2.54
      },
      {
        "companyName": "mc2",
        "companyId": "mc2_partner_id",
        "products": [
          {
            "productName": "bundle2",
            "productId": 720,
            "quantity": 1.1,
            "unitPrice": 2.54,
            "unit": "string",
            "avgMonthlyCost": 3.11
          },
          {
            "productName": "addon",
            "productId": 916,
            "quantity": 1.1,
            "unitPrice": 2.54,
            "unit": "string",
            "avgMonthlyCost": 3.11
          }
        ],
        "total": 2.54
      }
    ],
    "subTotal": 10.1,
    "tax": 0,
    "totalCost": 10.1,
    "currency": "USD"
  }
}

Cancel Paid Account

post

/cancel-paid-account

Cancel Paid Account

Authorizations

AuthorizationstringRequired

JWT with HS512 alg

Header parameters

AuthorizationstringOptional

Bearer

vendorstringOptional

vendor_name(Provided by Keeper)

Body

Responses

200

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

post

/cancel-paid-account

POST /bi_api/v1/services/mspvendor/cancel-paid-account HTTP/1.1
Host: keepersecurity.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 20

{
  "partnerId": "text"
}

{
  "success": true,
  "message": "Cancelled paid account"
}

Create Trial Account

post

/create-trial-account

Create Trial Account

Header parameters

AuthorizationstringOptional

Bearer JWT

vendorstringOptional

vendor_name(Provided by Keeper)

Body

Create Trial Account Request

namestring · max: 255Required

countrystring · max: 2Required

iso standard country code

Example: US

zipCodestring · max: 12Required

emailstring · emailRequired

vendorInternalIdstring · min: 1 · max: 52Required

statestringOptional

citystringOptional

streetstringOptional

phonestring · max: 15Optional

Country Code followed by phone number

Example: +1 9191919191

showPricingInMSPConsolebooleanOptionalDefault: false

Responses

200

Success Response

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

post

/create-trial-account

POST /bi_api/v1/services/mspvendor/create-trial-account HTTP/1.1
Host: keepersecurity.com
Content-Type: application/json
Accept: */*
Content-Length: 199

{
  "name": "text",
  "country": "US",
  "zipCode": "text",
  "email": "[email protected]",
  "vendorInternalId": "text",
  "state": "text",
  "city": "text",
  "street": "text",
  "phone": "+1 9191919191",
  "showPricingInMSPConsole": false
}

{
  "success": true,
  "partnerDetails": {
    "partnerId": "12345678-1234-5678-1234-567812345678",
    "first name": "John",
    "last name": "Doe",
    "country": "US",
    "locale": "en_US",
    "state": "Colorado",
    "city": "Broomfield",
    "street": "4753 Pine Garden Lane",
    "zipCode": "80021",
    "phone": "+1 9191919191",
    "email": "[email protected]",
    "vendorInternalId": "msp-vendor-internal-id12345678-1234-5678-1234-567812345678",
    "trial": true,
    "showPricingInMSPConsole": false
  }
}

Fetch All MSPs linked to vendor

get

/accounts

Get All linked MSPs

Authorizations

AuthorizationstringRequired

JWT with HS512 alg

Header parameters

AuthorizationstringOptional

Bearer

vendorstringOptional

vendor_name(Provided by Keeper)

Responses

200

application/json

401

Unauthorized

application/json

get

/accounts

GET /bi_api/v1/services/mspvendor/accounts HTTP/1.1
Host: keepersecurity.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "success": true,
  "accounts": [
    {
      "companyName": "msp11",
      "vendorInternalId": "msp11_internalId",
      "email": "email11",
      "status": "TRIAL"
    },
    {
      "companyName": "msp12",
      "vendorInternalId": "msp13_internalId",
      "email": "email12",
      "status": "ACTIVE"
    },
    {
      "companyName": "msp13",
      "vendorInternalId": "msp13_internalId",
      "email": "email13",
      "status": "EXPIRED"
    },
    {
      "vendorInternalId": "msp14_internalId",
      "email": "email14",
      "status": "PENDING"
    },
    {
      "vendorInternalId": "msp15_internalId",
      "email": "email15",
      "status": "REGION_CONFLICT",
      "accountRegion": "US"
    },
    {
      "vendorInternalId": "msp16_internalId",
      "email": "email16",
      "status": "PRODUCT_CONFLICT",
      "productType": "ENTERPRISE_TRIAL"
    }
  ]
}

Activate Expired Account

post

/activate-expired

Activate Expired Account

Authorizations

AuthorizationstringRequired

JWT with HS512 alg

Header parameters

AuthorizationstringOptional

Bearer

vendorstringOptional

vendor_name(Provided by Keeper)

Body

Responses

200

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

post

/activate-expired

POST /bi_api/v1/services/mspvendor/activate-expired HTTP/1.1
Host: keepersecurity.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 27

{
  "vendorInternalId": "text"
}

{
  "success": true,
  "message": "Activated Expired Account"
}

Fetch available Keeper MSP Products

get

/msp-products

Get available Keeper MSP products

Authorizations

AuthorizationstringRequired

JWT with HS512 alg

Header parameters

AuthorizationstringOptional

Bearer

vendorstringOptional

vendor_name(Provided by Keeper)

Responses

200

application/json

401

Unauthorized

application/json

get

/msp-products

GET /bi_api/v1/services/mspvendor/msp-products HTTP/1.1
Host: keepersecurity.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "success": true,
  "products": [
    {
      "productId": 720,
      "productName": "Keeper MSP"
    }
  ]
}

Delete Pending/Conflict Account

post

/remove-account

Delete Pending/Conflict Account

Authorizations

AuthorizationstringRequired

JWT with HS512 alg

Header parameters

AuthorizationstringOptional

Bearer

vendorstringOptional

vendor_name(Provided by Keeper)

Body

Responses

200

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

post

/remove-account

POST /bi_api/v1/services/mspvendor/remove-account HTTP/1.1
Host: keepersecurity.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 20

{
  "partnerId": "text"
}

{
  "success": true,
  "message": "Deleted Pending/Conflict Account"
}

Creating a JSON Web Token from your pre-shared secret

After access has been requested, Keeper will share a record with you that will include the necessary information to use the APIs. In order to use any of the above API methods, a JWT needs to be created. In the below example, the 'iat' and 'exp' are 5 minutes apart. The below code will generate the token needed in the web request:

 System.out.println(LocalDateTime.now().toEpochSecond(ZoneOffset.UTC));
       System.out.println(LocalDateTime.now().plusMinutes(5).toEpochSecond(ZoneOffset.UTC));

Sample JWT script example

The below script will correctly generate JWT and has the data needed for the 'create-trial-account' POST.

var jwt = require('jsonwebtoken');
var request = require('request');
var rightnowTimeStampInSeconds = Math.floor(Date.now() / 1000);
jwt.sign({
    "iat": rightnowTimeStampInSeconds ,
    "iss": "PARTNER_KEY",
    "exp": rightnowTimeStampInSeconds + (60*5) //adding 5 mins
  }, "PARTNER_SECRET", { algorithm: 'HS512' }, function(err, token) {
    var options = {
    'method': 'POST',
    'url': '',
    'headers': {
        'vendor': 'PARTNER_NAME',
        'Authorization': 'Bearer '+ token,
        'Content-Type': 'application/json'
    },
    body: '{"name":"string","country":"US","zipCode":"98001","email":"[email protected]","vendorInternalId":"89654we7r64ert65","state":"CA","city":"My city","street":"the street","phone":"19191919191"}'

    };
    request(options, function (error, response) {
        if (error) console.log("Error From the server: "+error);
        console.log("response body: "+response.body);
    });
});

Other methods to generate the JWT

You can use a look like JWT.io to generate your JSON Web Token from the pre-shared secret.

For encryption, use HS512 Algorithm
Use the below json as payload, note this token has a 5 minute expiration
use secret.key as secret key to encode the token

{
  "iat": timestamp in unix ,
  "iss": "consumer.key",
  "exp": timestamp in unix 
}

Additional API detail

MSP Account Statuses

Certain API endpoints will return the status of an MSP. The below explains what each status is:

Status

Definition

PENDING

When an account is created created via the /create-trial-account endpoint, an email is sent inviting the user to activate the account and begin thier trial.

TRIAL

A newly activated MSP automatically starts with a 14 day trial. At the end of the trial, if the /convert-to-paid endpoint is not called, the MSP will be deactivated and they can no longer login. Data will be deleted after 1 year. An expired trial can be re-activated within the data retenion period.

ACTIVE

An active, paid MSP account with an expiration date some time in the future.

REGION_CONFLICT

When an account is created via the /create-trial-account endpoint in US region instead of activating account from email link, user activated trial account from website in other region. Field “accountRegion” in response shows the registered account region.

PRODUCT_CONFLICT

When an account is created created via the /create-trial-account endpoint in US region instead of activating account from email link, user activated enterprise trial/consumer trial account from website. Field “productType” in response shows the Keeper product type

EXPIRED

if the /cancel-paid-account endpoint is called, the MSP provided will be immediately expired and billing will stop for this MSP.

Product ID to SKU mapping

Each Keeper line item has a human readable name that maps to ID's. These are provided in the usage API endpoints.

productID

Line Item

720

Keeper MSP

10001

Keeper Business

10002

Keeper Business Plus

10010

Keeper Enterprise

10011

Keeper Enterprise Plus

967

Keeper Connection Manager Add On

968

Keeper Secrets Manager Add On

910

KeeperChat Add On

920

Keeper ARAM Add On

930

Keeper BreachWatch Add On

940

Keeper Compliance Reporting Add On

1011

Keeper 1TB Storage Add On

1012

Keeper 10TB Storage Add On

730

Dedicated Service & Support

973

Remote Browser Isolation

978

Privilege Access Management

API definition YAML file

If you wish to explore the APIs in another tool like postman or the swagger editor, download the associated YAML definition of the APIs below

35KB

msp_vendor_api_v9.yaml

Open

Sample output of current usage

{
    "success": true,
    "usage": {
        "mcItems": [
            {
                "companyId": "NDU5ODU",
                "companyName": "Cowboys",
                "plan": "Keeper Business Bundle",
                "invitedUsers": 1,
                "maximumAllowedUsers": 5,
                "products": [
                    {
                        "unit": "bundles",
                        "quantity": 1,
                        "productId": 10001,
                        "productName": "Keeper Business Bundle"
                    }
                ]
            },
            {
                "companyId": "NDU5ODY",
                "companyName": "Eagles",
                "plan": "Keeper Business Plus Bundle",
                "invitedUsers": 1,
                "maximumAllowedUsers": 5,
                "products": [
                    {
                        "unit": "bundles",
                        "quantity": 1,
                        "productId": 10002,
                        "productName": "Keeper Business Plus Bundle"
                    }
                ]
            },
            {
                "companyId": "NDU5ODc",
                "companyName": "Commanders",
                "plan": "Keeper Enterprise Bundle",
                "invitedUsers": 1,
                "maximumAllowedUsers": 5,
                "products": [
                    {
                        "unit": "bundles",
                        "quantity": 1,
                        "productId": 10010,
                        "productName": "Keeper Enterprise Bundle"
                    }
                ]
            },
            {
                "companyId": "NDU5ODg",
                "companyName": "Giants",
                "plan": "Keeper Enterprise Plus Bundle",
                "invitedUsers": 1,
                "maximumAllowedUsers": 5,
                "products": [
                    {
                        "unit": "bundles",
                        "quantity": 1,
                        "productId": 10011,
                        "productName": "Keeper Enterprise Plus Bundle"
                    }
                ]
            },
            {
                "companyId": "NDU5ODk",
                "companyName": "Packers",
                "plan": "Keeper Enterprise Bundle",
                "invitedUsers": 1,
                "maximumAllowedUsers": 5,
                "products": [
                    {
                        "unit": "bundles",
                        "quantity": 30,
                        "productId": 10010,
                        "productName": "Keeper Enterprise Bundle"
                    },
                    {
                        "unit": "GB",
                        "quantity": 1000,
                        "productId": 1011,
                        "productName": "1TB Secure File Storage"
                    }
                ]
            },
            {
                "companyId": "NDU5OTA",
                "companyName": "Vikings",
                "plan": "Keeper Business Plus Bundle",
                "invitedUsers": 1,
                "maximumAllowedUsers": 5,
                "products": [
                    {
                        "unit": "bundles",
                        "quantity": 1,
                        "productId": 10002,
                        "productName": "Keeper Business Plus Bundle"
                    }
                ]
            },
            {
                "companyId": "NDU5OTE",
                "companyName": "Bears",
                "plan": "Keeper Enterprise Plus Bundle",
                "invitedUsers": 1,
                "maximumAllowedUsers": 5,
                "products": [
                    {
                        "unit": "bundles",
                        "quantity": 30,
                        "productId": 10011,
                        "productName": "Keeper Enterprise Plus Bundle"
                    }
                ]
            },
            {
                "companyId": "NDU5OTI",
                "companyName": "Lions",
                "plan": "Keeper Enterprise Plus Bundle",
                "invitedUsers": 1,
                "maximumAllowedUsers": 5,
                "products": [
                    {
                        "unit": "bundles",
                        "quantity": 1,
                        "productId": 10011,
                        "productName": "Keeper Enterprise Plus Bundle"
                    }
                ]
            },
            {
                "companyId": "NDU5OTM",
                "companyName": "Buccaneers",
                "plan": "Keeper Business Bundle",
                "invitedUsers": 1,
                "maximumAllowedUsers": 5,
                "products": [
                    {
                        "unit": "bundles",
                        "quantity": 1,
                        "productId": 10001,
                        "productName": "Keeper Business Bundle"
                    }
                ]
            },
            {
                "companyId": "NDU5OTQ",
                "companyName": "Saints",
                "plan": "Keeper Business Plus Bundle",
                "invitedUsers": 1,
                "maximumAllowedUsers": 5,
                "products": [
                    {
                        "unit": "bundles",
                        "quantity": 1,
                        "productId": 10002,
                        "productName": "Keeper Business Plus Bundle"
                    }
                ]
            },
            {
                "companyId": "NDU5OTU",
                "companyName": "Falcons",
                "plan": "Keeper Enterprise Bundle",
                "invitedUsers": 1,
                "maximumAllowedUsers": 5,
                "products": [
                    {
                        "unit": "bundles",
                        "quantity": 1,
                        "productId": 10010,
                        "productName": "Keeper Enterprise Bundle"
                    }
                ]
            },
            {
                "companyId": "NDkzNDk",
                "companyName": "MC Test",
                "plan": "Keeper Enterprise Plus Bundle",
                "invitedUsers": 1,
                "maximumAllowedUsers": 5,
                "products": [
                    {
                        "unit": "bundles",
                        "quantity": 1,
                        "productId": 10011,
                        "productName": "Keeper Enterprise Plus Bundle"
                    },
                    {
                        "unit": "GB",
                        "quantity": 10000,
                        "productId": 1012,
                        "productName": "10TB Secure File Storage"
                    }
                ]
            },
            {
                "companyId": "NDU5OTY",
                "companyName": "Panthers",
                "plan": "Keeper Enterprise Plus Bundle",
                "invitedUsers": 1,
                "maximumAllowedUsers": 5,
                "products": [
                    {
                        "unit": "bundles",
                        "quantity": 1,
                        "productId": 10011,
                        "productName": "Keeper Enterprise Plus Bundle"
                    }
                ]
            },
            {
                "companyId": "NDU5OTc",
                "companyName": "Rams",
                "plan": "Keeper Enterprise Bundle",
                "invitedUsers": 1,
                "maximumAllowedUsers": 5,
                "products": [
                    {
                        "unit": "bundles",
                        "quantity": 2,
                        "productId": 10001,
                        "productName": "Keeper Business Bundle"
                    }
                ]
            },
            {
                "companyId": "NDU5OTg",
                "companyName": "Cardinals",
                "plan": "Keeper Business Plus Bundle",
                "invitedUsers": 1,
                "maximumAllowedUsers": 5,
                "products": [
                    {
                        "unit": "bundles",
                        "quantity": 1,
                        "productId": 10002,
                        "productName": "Keeper Business Plus Bundle"
                    }
                ]
            },
            {
                "companyId": "NDU5OTk",
                "companyName": "49ers",
                "plan": "Keeper Enterprise Bundle",
                "invitedUsers": 1,
                "maximumAllowedUsers": 5,
                "products": [
                    {
                        "unit": "bundles",
                        "quantity": 1,
                        "productId": 10010,
                        "productName": "Keeper Enterprise Bundle"
                    }
                ]
            },
            {
                "companyId": "NDYwMDA",
                "companyName": "seahawks",
                "plan": "Keeper Enterprise Plus Bundle",
                "invitedUsers": 1,
                "maximumAllowedUsers": 5,
                "products": [
                    {
                        "unit": "bundles",
                        "quantity": 2,
                        "productId": 10011,
                        "productName": "Keeper Enterprise Plus Bundle"
                    }
                ]
            },
            {
                "companyId": "NDYwMDE",
                "companyName": "NFC Business",
                "plan": "Keeper Business Bundle",
                "invitedUsers": 1,
                "maximumAllowedUsers": 5,
                "products": [
                    {
                        "unit": "bundles",
                        "quantity": 10,
                        "productId": 10001,
                        "productName": "Keeper Business Bundle"
                    }
                ]
            },
            {
                "companyId": "NDYwMDI",
                "companyName": "NFC Business Plus",
                "plan": "Keeper Business Plus Bundle",
                "invitedUsers": 1,
                "maximumAllowedUsers": 5,
                "products": [
                    {
                        "unit": "bundles",
                        "quantity": 1,
                        "productId": 10002,
                        "productName": "Keeper Business Plus Bundle"
                    }
                ]
            },
            {
                "companyId": "NDY5NTk",
                "companyName": "NFC Business - All Upgrades",
                "plan": "Keeper Business Bundle",
                "invitedUsers": 1,
                "maximumAllowedUsers": 5,
                "products": [
                    {
                        "unit": "bundles",
                        "quantity": 1,
                        "productId": 10001,
                        "productName": "Keeper Business Bundle"
                    },
                    {
                        "unit": "GB",
                        "quantity": 10000,
                        "productId": 1012,
                        "productName": "10TB Secure File Storage"
                    }
                ]
            },
            {
                "companyId": "NDYwMDM",
                "companyName": "NFC Enterprise",
                "plan": "Keeper Enterprise Bundle",
                "invitedUsers": 1,
                "maximumAllowedUsers": 5,
                "products": [
                    {
                        "unit": "bundles",
                        "quantity": 1,
                        "productId": 10010,
                        "productName": "Keeper Enterprise Bundle"
                    }
                ]
            },
            {
                "companyId": "NDY5NjA",
                "companyName": "NFC Business Plus - All Upgrades",
                "plan": "Keeper Business Plus Bundle",
                "invitedUsers": 1,
                "maximumAllowedUsers": 5,
                "products": [
                    {
                        "unit": "bundles",
                        "quantity": 1,
                        "productId": 10002,
                        "productName": "Keeper Business Plus Bundle"
                    },
                    {
                        "unit": "GB",
                        "quantity": 10000,
                        "productId": 1012,
                        "productName": "10TB Secure File Storage"
                    }
                ]
            },
            {
                "companyId": "NDYwMDQ",
                "companyName": "NFC Enterprise Plus",
                "plan": "Keeper Enterprise Plus Bundle",
                "invitedUsers": 1,
                "maximumAllowedUsers": 5,
                "products": [
                    {
                        "unit": "bundles",
                        "quantity": 1,
                        "productId": 10011,
                        "productName": "Keeper Enterprise Plus Bundle"
                    }
                ]
            },
            {
                "companyId": "NDY5NjE",
                "companyName": "NFC Enterprise Plus - All Upgrades",
                "plan": "Keeper Enterprise Plus Bundle",
                "invitedUsers": 1,
                "maximumAllowedUsers": 5,
                "products": [
                    {
                        "unit": "bundles",
                        "quantity": 1,
                        "productId": 10011,
                        "productName": "Keeper Enterprise Plus Bundle"
                    },
                    {
                        "unit": "GB",
                        "quantity": 10000,
                        "productId": 1012,
                        "productName": "10TB Secure File Storage"
                    }
                ]
            },
            {
                "companyId": "NDY5NjI",
                "companyName": "NFC Enterprise - All Upgrades",
                "plan": "Keeper Enterprise Bundle",
                "invitedUsers": 1,
                "maximumAllowedUsers": 5,
                "products": [
                    {
                        "unit": "bundles",
                        "quantity": 1,
                        "productId": 10010,
                        "productName": "Keeper Enterprise Bundle"
                    },
                    {
                        "unit": "GB",
                        "quantity": 10000,
                        "productId": 1012,
                        "productName": "10TB Secure File Storage"
                    }
                ]
            },
            {
                "companyId": "NDYwMDk",
                "companyName": "Company 1",
                "plan": "Keeper Business Bundle",
                "invitedUsers": 1,
                "maximumAllowedUsers": 5,
                "products": [
                    {
                        "unit": "bundles",
                        "quantity": 1,
                        "productId": 10001,
                        "productName": "Keeper Business Bundle"
                    }
                ]
            },
            {
                "companyId": "NDYwMTA",
                "companyName": "Company 2",
                "plan": "Keeper Business Plus Bundle",
                "invitedUsers": 1,
                "maximumAllowedUsers": 5,
                "products": [
                    {
                        "unit": "bundles",
                        "quantity": 1,
                        "productId": 10002,
                        "productName": "Keeper Business Plus Bundle"
                    }
                ]
            }
        ],
        "mspItem": {
            "companyId": "NDU5Njg",
            "companyName": "QaMspNfl",
            "invitedUsers": 1,
            "products": [
                {
                    "unit": "licenses",
                    "quantity": 31,
                    "productId": 720,
                    "productName": "MSP Base License"
                },
                {
                    "unit": "GB",
                    "quantity": 10000,
                    "productId": 1012,
                    "productName": "10TB Secure File Storage"
                },
                {
                    "unit": "",
                    "quantity": 1,
                    "productId": 730,
                    "productName": "Dedicated Service & Support"
                },
                {
                    "unit": "licenses",
                    "quantity": 31,
                    "productId": 920,
                    "productName": "Advanced Reporting & Alerts"
                },
                {
                    "unit": "licenses",
                    "quantity": 31,
                    "productId": 940,
                    "productName": "Compliance Reporting"
                },
                {
                    "unit": "licenses",
                    "quantity": 31,
                    "productId": 930,
                    "productName": "BreachWatch"
                },
                {
                    "unit": "KCM users",
                    "quantity": 10,
                    "productId": 967,
                    "productName": "Keeper Connection Manager (KCM)"
                },
                {
                    "unit": "licenses",
                    "quantity": 31,
                    "productId": 910,
                    "productName": "KeeperChat"
                }
            ]
        }
    }
}

Sample output of monthly usage

{"success":true,"usage":{"total":2387.74,"tax":0,"currency":"USD","mcItems":[{"companyId":"NDU5OTk","total":3,"companyName":"49ers","products":[{"unitPrice":3,"unit":"user","quantity":1,"productId":10010,"productName":"Keeper Enterprise Bundle","avgMonthlyCost":3}]},{"companyId":"NDU5OTE","total":278.2,"companyName":"Bears","products":[{"unitPrice":4.8,"unit":"user","quantity":30,"productId":10011,"productName":"Keeper Enterprise Plus Bundle","avgMonthlyCost":144},{"unitPrice":0.5,"unit":"user","quantity":30,"productId":940,"productName":"Compliance Reporting","avgMonthlyCost":15},{"unitPrice":64,"quantity":1,"productId":730,"productName":"Dedicated Service & Support","avgMonthlyCost":64},{"unitPrice":25.2,"unit":"user","quantity":1,"productId":967,"productName":"Keeper Connection Manager (KCM)","avgMonthlyCost":25.2},{"unitPrice":1,"unit":"user","quantity":30,"productId":910,"productName":"KeeperChat","avgMonthlyCost":30}]},{"companyId":"NDU5OTM","total":2.25,"companyName":"Buccaneers","products":[{"unitPrice":2.25,"unit":"user","quantity":1,"productId":10001,"productName":"Keeper Business Bundle","avgMonthlyCost":2.25}]},{"companyId":"NDU5OTg","total":4.2,"companyName":"Cardinals","products":[{"unitPrice":4.2,"unit":"user","quantity":1,"productId":10002,"productName":"Keeper Business Plus Bundle","avgMonthlyCost":4.2}]},{"companyId":"NDU5ODc","total":3,"companyName":"Commanders","products":[{"unitPrice":3,"unit":"user","quantity":1,"productId":10010,"productName":"Keeper Enterprise Bundle","avgMonthlyCost":3}]},{"companyId":"NDYwMDk","total":2.25,"companyName":"Company 1","products":[{"unitPrice":2.25,"unit":"user","quantity":1,"productId":10001,"productName":"Keeper Business Bundle","avgMonthlyCost":2.25}]},{"companyId":"NDYwMTA","total":4.2,"companyName":"Company 2","products":[{"unitPrice":4.2,"unit":"user","quantity":1,"productId":10002,"productName":"Keeper Business Plus Bundle","avgMonthlyCost":4.2}]},{"companyId":"NDU5ODU","total":2.25,"companyName":"Cowboys","products":[{"unitPrice":2.25,"unit":"user","quantity":1,"productId":10001,"productName":"Keeper Business Bundle","avgMonthlyCost":2.25}]},{"companyId":"NDU5ODY","total":4.2,"companyName":"Eagles","products":[{"unitPrice":4.2,"unit":"user","quantity":1,"productId":10002,"productName":"Keeper Business Plus Bundle","avgMonthlyCost":4.2}]},{"companyId":"NDU5OTU","total":3,"companyName":"Falcons","products":[{"unitPrice":3,"unit":"user","quantity":1,"productId":10010,"productName":"Keeper Enterprise Bundle","avgMonthlyCost":3}]},{"companyId":"NDU5ODg","total":4.8,"companyName":"Giants","products":[{"unitPrice":4.8,"unit":"user","quantity":1,"productId":10011,"productName":"Keeper Enterprise Plus Bundle","avgMonthlyCost":4.8}]},{"companyId":"NDU5OTI","total":4.8,"companyName":"Lions","products":[{"unitPrice":4.8,"unit":"user","quantity":1,"productId":10011,"productName":"Keeper Enterprise Plus Bundle","avgMonthlyCost":4.8}]},{"companyId":"NDkzNDk","total":181.04,"companyName":"MC Test","products":[{"unitPrice":4.8,"unit":"user","quantity":0.89,"productId":10011,"productName":"Keeper Enterprise Plus Bundle","avgMonthlyCost":4.27},{"unitPrice":89,"quantity":1,"productId":1012,"productName":"10TB Secure File Storage","avgMonthlyCost":89},{"unitPrice":0.5,"unit":"user","quantity":0.89,"productId":940,"productName":"Compliance Reporting","avgMonthlyCost":0.45},{"unitPrice":64,"quantity":1,"productId":730,"productName":"Dedicated Service & Support","avgMonthlyCost":64},{"unitPrice":25.2,"unit":"user","quantity":0.89,"productId":967,"productName":"Keeper Connection Manager (KCM)","avgMonthlyCost":22.43},{"unitPrice":1,"unit":"user","quantity":0.89,"productId":910,"productName":"KeeperChat","avgMonthlyCost":0.89}]},{"companyId":"NDYwMDE","total":37.5,"companyName":"NFC Business","products":[{"unitPrice":2.25,"unit":"user","quantity":10,"productId":10001,"productName":"Keeper Business Bundle","avgMonthlyCost":22.5},{"unitPrice":0.5,"unit":"user","quantity":10,"productId":920,"productName":"Advanced Reporting & Alerts","avgMonthlyCost":5},{"unitPrice":1,"unit":"user","quantity":10,"productId":930,"productName":"BreachWatch","avgMonthlyCost":10}]},{"companyId":"NDY5NTk","total":421.25,"companyName":"NFC Business - All Upgrades","products":[{"unitPrice":2.25,"unit":"user","quantity":1,"productId":10001,"productName":"Keeper Business Bundle","avgMonthlyCost":2.25},{"unitPrice":100,"quantity":1,"productId":1012,"productName":"10TB Secure File Storage","avgMonthlyCost":100},{"unitPrice":0.5,"unit":"user","quantity":1,"productId":920,"productName":"Advanced Reporting & Alerts","avgMonthlyCost":0.5},{"unitPrice":1,"unit":"user","quantity":1,"productId":930,"productName":"BreachWatch","avgMonthlyCost":1},{"unitPrice":0.5,"unit":"user","quantity":1,"productId":940,"productName":"Compliance Reporting","avgMonthlyCost":0.5},{"unitPrice":64,"quantity":1,"productId":730,"productName":"Dedicated Service & Support","avgMonthlyCost":64},{"unitPrice":25.2,"unit":"user","quantity":10,"productId":967,"productName":"Keeper Connection Manager (KCM)","avgMonthlyCost":252},{"unitPrice":1,"unit":"user","quantity":1,"productId":910,"productName":"KeeperChat","avgMonthlyCost":1}]},{"companyId":"NDYwMDI","total":4.2,"companyName":"NFC Business Plus","products":[{"unitPrice":4.2,"unit":"user","quantity":1,"productId":10002,"productName":"Keeper Business Plus Bundle","avgMonthlyCost":4.2}]},{"companyId":"NDY5NjA","total":194.9,"companyName":"NFC Business Plus - All Upgrades","products":[{"unitPrice":4.2,"unit":"user","quantity":1,"productId":10002,"productName":"Keeper Business Plus Bundle","avgMonthlyCost":4.2},{"unitPrice":100,"quantity":1,"productId":1012,"productName":"10TB Secure File Storage","avgMonthlyCost":100},{"unitPrice":0.5,"unit":"user","quantity":1,"productId":940,"productName":"Compliance Reporting","avgMonthlyCost":0.5},{"unitPrice":64,"quantity":1,"productId":730,"productName":"Dedicated Service & Support","avgMonthlyCost":64},{"unitPrice":25.2,"unit":"user","quantity":1,"productId":967,"productName":"Keeper Connection Manager (KCM)","avgMonthlyCost":25.2},{"unitPrice":1,"unit":"user","quantity":1,"productId":910,"productName":"KeeperChat","avgMonthlyCost":1}]},{"companyId":"NDYwMDM","total":3,"companyName":"NFC Enterprise","products":[{"unitPrice":3,"unit":"user","quantity":1,"productId":10010,"productName":"Keeper Enterprise Bundle","avgMonthlyCost":3}]},{"companyId":"NDY5NjI","total":195.2,"companyName":"NFC Enterprise - All Upgrades","products":[{"unitPrice":3,"unit":"user","quantity":1,"productId":10010,"productName":"Keeper Enterprise Bundle","avgMonthlyCost":3},{"unitPrice":100,"quantity":1,"productId":1012,"productName":"10TB Secure File Storage","avgMonthlyCost":100},{"unitPrice":0.5,"unit":"user","quantity":1,"productId":920,"productName":"Advanced Reporting & Alerts","avgMonthlyCost":0.5},{"unitPrice":1,"unit":"user","quantity":1,"productId":930,"productName":"BreachWatch","avgMonthlyCost":1},{"unitPrice":0.5,"unit":"user","quantity":1,"productId":940,"productName":"Compliance Reporting","avgMonthlyCost":0.5},{"unitPrice":64,"quantity":1,"productId":730,"productName":"Dedicated Service & Support","avgMonthlyCost":64},{"unitPrice":25.2,"unit":"user","quantity":1,"productId":967,"productName":"Keeper Connection Manager (KCM)","avgMonthlyCost":25.2},{"unitPrice":1,"unit":"user","quantity":1,"productId":910,"productName":"KeeperChat","avgMonthlyCost":1}]},{"companyId":"NDYwMDQ","total":4.8,"companyName":"NFC Enterprise Plus","products":[{"unitPrice":4.8,"unit":"user","quantity":1,"productId":10011,"productName":"Keeper Enterprise Plus Bundle","avgMonthlyCost":4.8}]},{"companyId":"NDY5NjE","total":195.5,"companyName":"NFC Enterprise Plus - All Upgrades","products":[{"unitPrice":4.8,"unit":"user","quantity":1,"productId":10011,"productName":"Keeper Enterprise Plus Bundle","avgMonthlyCost":4.8},{"unitPrice":100,"quantity":1,"productId":1012,"productName":"10TB Secure File Storage","avgMonthlyCost":100},{"unitPrice":0.5,"unit":"user","quantity":1,"productId":940,"productName":"Compliance Reporting","avgMonthlyCost":0.5},{"unitPrice":64,"quantity":1,"productId":730,"productName":"Dedicated Service & Support","avgMonthlyCost":64},{"unitPrice":25.2,"unit":"user","quantity":1,"productId":967,"productName":"Keeper Connection Manager (KCM)","avgMonthlyCost":25.2},{"unitPrice":1,"unit":"user","quantity":1,"productId":910,"productName":"KeeperChat","avgMonthlyCost":1}]},{"companyId":"NDU5ODk","total":239,"companyName":"Packers","products":[{"unitPrice":3,"unit":"user","quantity":30,"productId":10010,"productName":"Keeper Enterprise Bundle","avgMonthlyCost":90},{"unitPrice":25,"quantity":1,"productId":1011,"productName":"1TB Secure File Storage","avgMonthlyCost":25},{"unitPrice":0.5,"unit":"user","quantity":30,"productId":920,"productName":"Advanced Reporting & Alerts","avgMonthlyCost":15},{"unitPrice":1,"unit":"user","quantity":30,"productId":930,"productName":"BreachWatch","avgMonthlyCost":30},{"unitPrice":0.5,"unit":"user","quantity":30,"productId":940,"productName":"Compliance Reporting","avgMonthlyCost":15},{"unitPrice":64,"quantity":1,"productId":730,"productName":"Dedicated Service & Support","avgMonthlyCost":64}]},{"companyId":"NDU5OTY","total":4.8,"companyName":"Panthers","products":[{"unitPrice":4.8,"unit":"user","quantity":1,"productId":10011,"productName":"Keeper Enterprise Plus Bundle","avgMonthlyCost":4.8}]},{"companyId":"NDU5OTc","total":4.5,"companyName":"Rams","products":[{"unitPrice":2.25,"unit":"user","quantity":2,"productId":10001,"productName":"Keeper Business Bundle","avgMonthlyCost":4.5}]},{"companyId":"NDU5OTQ","total":4.2,"companyName":"Saints","products":[{"unitPrice":4.2,"unit":"user","quantity":1,"productId":10002,"productName":"Keeper Business Plus Bundle","avgMonthlyCost":4.2}]},{"companyId":"NDYwMDA","total":9.6,"companyName":"seahawks","products":[{"unitPrice":4.8,"unit":"user","quantity":2,"productId":10011,"productName":"Keeper Enterprise Plus Bundle","avgMonthlyCost":9.6}]},{"companyId":"NDU5OTA","total":4.2,"companyName":"Vikings","products":[{"unitPrice":4.2,"unit":"user","quantity":1,"productId":10002,"productName":"Keeper Business Plus Bundle","avgMonthlyCost":4.2}]}],"subTotal":2387.74,"mspItem":{"companyId":"NDU5Njg","total":567.9,"companyName":"QaMspNfl","products":[{"unitPrice":3.4,"unit":"user","quantity":31,"productId":720,"productName":"MSP Base License","avgMonthlyCost":105.4},{"unitPrice":100,"quantity":1,"productId":1012,"productName":"10TB Secure File Storage","avgMonthlyCost":100},{"unitPrice":0.5,"unit":"user","quantity":31,"productId":940,"productName":"Compliance Reporting","avgMonthlyCost":15.5},{"unitPrice":64,"quantity":1,"productId":730,"productName":"Dedicated Service & Support","avgMonthlyCost":64},{"unitPrice":25.2,"unit":"user","quantity":10,"productId":967,"productName":"Keeper Connection Manager (KCM)","avgMonthlyCost":252},{"unitPrice":1,"unit":"user","quantity":31,"productId":910,"productName":"KeeperChat","avgMonthlyCost":31}]}}}

The account creation API will automatically send an email to the created/invited account. Exmaple below.

If you need support or have additional questions on the usage of these APIs, please contact support or your sales representative.

PreviousCommander CLI/SDK NextMSP Best Practices

Last updated 8 months ago

Was this helpful?