Child Users Guide

This guide will explain what Child Users are, and why they could be a useful function in your shipping application.

A child User is essentially a dependent clone of a parent User. We've created child User functionality as a way for organizations to organize users with their own carrier credentials. Child Users can not log into the EasyPost website, and they can only be created in production mode with your production API key.

Upon creation, the child User will only have the parent User's USPS account by default. Any other carrier accounts that need to be added to the child User must be built into your application's logic on your end.

Other than organizing activity and CarrierAccounts the central advantage of a child account is that billing flows through the parent's payment information. This prevents the parent User from having to input duplicate billing information.

Child Users can serve a few important purposes within your organization:

  • You want to organize sets of users together, based on different parent User settings as templates.
  • Your consumers want to use your shipping application, but also want to use their own negotiated rates.
  • You want to exert greater control of your billing. All child Users roll their billing up to their parent User.

Of course, if you find another way to leverage child Users, feel free to build it. We love it when our customers use our API in creative ways.

The structure of a child User is identicial to its parent, which means that their representations contain many more properties than are actually used. Also, creating a child User requires almost none of the properties necessary for creating a top-level User.

Here is an example of a child user:

Creating a Child User
using EasyPost;
EasyPost.ClientManager.SetCurrent("<YOUR_PRODUCTION_API_KEY>");

User user = new User() { name = "Child Account Name" };

user.Create();

    
Child User JSON Response
{
  "id": "user_c06a0312345342XXX23r2f",
  "object": "User",
  "parent_id": "user_eb80487XXXXXXXXXw22347d8d",
  "name": "Child Account Name",
  "phone_number": "8005550100",
  "verified": true,
  "children": [],
  "api_keys": [
    {
      "object": "ApiKey",
      "key": "zktXXXXXXXXXXXX291h",
      "mode": "test",
      "created_at": "2018-06-07T16:10:34Z",
      "active": true,
      "id": "ak_bc1e6XXXXXXXXXXXXXXXXX94357f8"
    },
    {
      "object": "ApiKey",
      "key": "ApaXXXXXXXXXX130g",
      "mode": "production",
      "created_at": "2018-06-07T16:10:34Z",
      "active": true,
      "id": "ak_03ecbacXXXXXXXXXXXXc769a3cb6f"
    }
  ]
}