# Get account hierarchy for a customer

> For the complete machine-readable documentation index, see [llms.txt](https://apidocs.chargebee.com/llms.txt).


Retrieves the full or partial [account hierarchy](/docs/api/hierarchies) for a customer.

## Sample Request

### List the nodes of the full hierarchy to which the customer belongs.

#### cURL

```bash
curl  https://{site}.chargebee.com/api/v2/customers/foo/hierarchy \
     -G  \
     -u {site_api_key}:\
     -d hierarchy_operation_type="COMPLETE_HIERARCHY"
```

#### .NET

```dotnet
using ChargeBee.Api;
using ChargeBee.Models;
using ChargeBee.Models.Enums;

ApiConfig.Configure("{site}","{site_api_key}");
EntityResult result = Customer.Hierarchy("foo")
		.HierarchyOperationType(HierarchyOperationTypeEnum.CompleteHierarchy)
		.Request();

List<Hierarchy> hierarchies = result.Hierarchies;
```

#### Go

```go
package main
import (
    "fmt"
    "github.com/chargebee/chargebee-go/v3"
    customerAction "github.com/chargebee/chargebee-go/v3/actions/customer"
    "github.com/chargebee/chargebee-go/v3/models/customer"
    enum "github.com/chargebee/chargebee-go/v3/enum"
)
func main() {
    chargebee.Configure("{site_api_key}","{site}");
    res,err := customerAction.Hierarchy("foo", &customer.HierarchyRequestParams{
        HierarchyOperationType : enum.HierarchyOperationTypeCompleteHierarchy,
    }).Request()
    if err != nil {
        fmt.Println(err)
    } else {
        Hierarchies := res.Hierarchies
    }
}
```

#### Go

```go
package main

import (
  "fmt"
  "github.com/chargebee/chargebee-go/v4"
)

func main() {
  config := &chargebee.ClientConfig{
    SiteName: "{site}",
    ApiKey: "{site_api_key}",
  }    
  client := chargebee.NewClient(config)
  req := &chargebee.CustomerHierarchyRequest{
    HierarchyOperationType : chargebee.HierarchyOperationTypeCompleteHierarchy,
}
  res, err := client.Customer.Hierarchy("foo", req)
      if err != nil {
        fmt.Println(err)
    } else {
        Hierarchies := res.Hierarchies
    }
}
```

#### Java

```java
import com.chargebee.*;
import com.chargebee.ListResult;
import com.chargebee.models.*;
import com.chargebee.models.enums.*;
import java.io.IOException;
import java.util.List;

public class Sample {

    public static void main(String args[]) throws IOException, Exception {
        Environment.configure("{site}", "{site_api_key}");
        Result result = Customer.hierarchy("foo")
            .hierarchyOperationType(HierarchyOperationType.COMPLETE_HIERARCHY)
            .request();

        List<Hierarchy> hierarchies = result.hierarchies();
    }
}
```

#### Java

```java
import com.chargebee.v4.client.ChargebeeClient;
import com.chargebee.v4.models.customer.params.CustomerHierarchyParams;
import com.chargebee.v4.models.customer.responses.CustomerHierarchyResponse;
import com.chargebee.v4.models.hierarchy.Hierarchy;
import java.util.List;

public class CustomerHierarchy {

    public static void main(String[] args) {
        ChargebeeClient client = ChargebeeClient.builder()
            .apiKey("{site_api_key}")
            .siteName("{site}")
            .build();

        CustomerHierarchyParams params = CustomerHierarchyParams.builder()
            .hierarchyOperationType(CustomerHierarchyParams.HierarchyOperationType.COMPLETE_HIERARCHY)
            .build();

        CustomerHierarchyResponse response = client
            .customers()
            .hierarchy("foo", params);

        List<Hierarchy> hierarchies = response.getHierarchies();
    }
}
```

#### Node.js

```node
import Chargebee from "chargebee";

const chargebee = new Chargebee({
    site: "{site}",
    apiKey: "{site_api_key}",
});

try {
    const result = await chargebee.customer.hierarchy("foo", {
        hierarchy_operation_type: "complete_hierarchy"
    });

    console.log(result);
    const hierarchies = result.hierarchies;
} catch (err) {
    console.log(err);
}
```

#### PHP

```php
<?php

require __DIR__ . '/vendor/autoload.php';

use Chargebee\ChargebeeClient;

$chargebee = new ChargebeeClient(options: [
    "site" => "{site}",
    "apiKey" => "{site_api_key}",
]);
$result = $chargebee->customer()->hierarchy("foo", [
    "hierarchy_operation_type" => "complete_hierarchy"
]);
$hierarchies = $result->hierarchies;
```

#### Python

```python
import chargebee
from chargebee import Chargebee

cb_client = Chargebee(api_key="{site_api_key}", site="{site}")
response = cb_client.Customer.hierarchy("foo",
    cb_client.Customer.HierarchyParams(
        hierarchy_operation_type=chargebee.HierarchyOperationType.COMPLETE_HIERARCHY
    )
)
hierarchies = response.hierarchies
```

#### Ruby

```ruby
require 'chargebee'

ChargeBee.configure(:site => "{site}",
  :api_key => "{site_api_key}")

result = ChargeBee::Customer.hierarchy("foo",{
  :hierarchy_operation_type => "COMPLETE_HIERARCHY"
})

hierarchies = result.hierarchies
```

### List the nodes along the path from the customer to the root of the full hierarchy.

#### cURL

```bash
curl  https://{site}.chargebee.com/api/v2/customers/foo/hierarchy \
     -G  \
     -u {site_api_key}:\
     -d hierarchy_operation_type="PATH_TO_ROOT"
```

#### .NET

```dotnet
using ChargeBee.Api;
using ChargeBee.Models;
using ChargeBee.Models.Enums;

ApiConfig.Configure("{site}","{site_api_key}");
EntityResult result = Customer.Hierarchy("foo")
		.HierarchyOperationType(HierarchyOperationTypeEnum.PathToRoot)
		.Request();

List<Hierarchy> hierarchies = result.Hierarchies;
```

#### Go

```go
package main
import (
    "fmt"
    "github.com/chargebee/chargebee-go/v3"
    customerAction "github.com/chargebee/chargebee-go/v3/actions/customer"
    "github.com/chargebee/chargebee-go/v3/models/customer"
    enum "github.com/chargebee/chargebee-go/v3/enum"
)
func main() {
    chargebee.Configure("{site_api_key}","{site}");
    res,err := customerAction.Hierarchy("foo", &customer.HierarchyRequestParams{
        HierarchyOperationType : enum.HierarchyOperationTypePathToRoot,
    }).Request()
    if err != nil {
        fmt.Println(err)
    } else {
        Hierarchies := res.Hierarchies
    }
}
```

#### Go

```go
package main

import (
  "fmt"
  "github.com/chargebee/chargebee-go/v4"
)

func main() {
  config := &chargebee.ClientConfig{
    SiteName: "{site}",
    ApiKey: "{site_api_key}",
  }    
  client := chargebee.NewClient(config)
  req := &chargebee.CustomerHierarchyRequest{
    HierarchyOperationType : chargebee.HierarchyOperationTypePathToRoot,
}
  res, err := client.Customer.Hierarchy("foo", req)
      if err != nil {
        fmt.Println(err)
    } else {
        Hierarchies := res.Hierarchies
    }
}
```

#### Java

```java
import com.chargebee.*;
import com.chargebee.ListResult;
import com.chargebee.models.*;
import com.chargebee.models.enums.*;
import java.io.IOException;
import java.util.List;

public class Sample {

    public static void main(String args[]) throws IOException, Exception {
        Environment.configure("{site}", "{site_api_key}");
        Result result = Customer.hierarchy("foo")
            .hierarchyOperationType(HierarchyOperationType.PATH_TO_ROOT)
            .request();

        List<Hierarchy> hierarchies = result.hierarchies();
    }
}
```

#### Java

```java
import com.chargebee.v4.client.ChargebeeClient;
import com.chargebee.v4.models.customer.params.CustomerHierarchyParams;
import com.chargebee.v4.models.customer.responses.CustomerHierarchyResponse;
import com.chargebee.v4.models.hierarchy.Hierarchy;
import java.util.List;

public class CustomerHierarchy {

    public static void main(String[] args) {
        ChargebeeClient client = ChargebeeClient.builder()
            .apiKey("{site_api_key}")
            .siteName("{site}")
            .build();

        CustomerHierarchyParams params = CustomerHierarchyParams.builder()
            .hierarchyOperationType(CustomerHierarchyParams.HierarchyOperationType.PATH_TO_ROOT)
            .build();

        CustomerHierarchyResponse response = client
            .customers()
            .hierarchy("foo", params);

        List<Hierarchy> hierarchies = response.getHierarchies();
    }
}
```

#### Node.js

```node
import Chargebee from "chargebee";

const chargebee = new Chargebee({
    site: "{site}",
    apiKey: "{site_api_key}",
});

try {
    const result = await chargebee.customer.hierarchy("foo", {
        hierarchy_operation_type: "path_to_root"
    });

    console.log(result);
    const hierarchies = result.hierarchies;
} catch (err) {
    console.log(err);
}
```

#### PHP

```php
<?php

require __DIR__ . '/vendor/autoload.php';

use Chargebee\ChargebeeClient;

$chargebee = new ChargebeeClient(options: [
    "site" => "{site}",
    "apiKey" => "{site_api_key}",
]);
$result = $chargebee->customer()->hierarchy("foo", [
    "hierarchy_operation_type" => "path_to_root"
]);
$hierarchies = $result->hierarchies;
```

#### Python

```python
import chargebee
from chargebee import Chargebee

cb_client = Chargebee(api_key="{site_api_key}", site="{site}")
response = cb_client.Customer.hierarchy("foo",
    cb_client.Customer.HierarchyParams(
        hierarchy_operation_type=chargebee.HierarchyOperationType.PATH_TO_ROOT
    )
)
hierarchies = response.hierarchies
```

#### Ruby

```ruby
require 'chargebee'

ChargeBee.configure(:site => "{site}",
  :api_key => "{site_api_key}")

result = ChargeBee::Customer.hierarchy("foo",{
  :hierarchy_operation_type => "PATH_TO_ROOT"
})

hierarchies = result.hierarchies
```

### List all the nodes of the hierarchy formed by the customer and its subordinates.

#### cURL

```bash
curl  https://{site}.chargebee.com/api/v2/customers/foo/hierarchy \
     -G  \
     -u {site_api_key}:\
     -d hierarchy_operation_type="SUBORDINATES"
```

#### .NET

```dotnet
using ChargeBee.Api;
using ChargeBee.Models;
using ChargeBee.Models.Enums;

ApiConfig.Configure("{site}","{site_api_key}");
EntityResult result = Customer.Hierarchy("foo")
		.HierarchyOperationType(HierarchyOperationTypeEnum.Subordinates)
		.Request();

List<Hierarchy> hierarchies = result.Hierarchies;
```

#### Go

```go
package main
import (
    "fmt"
    "github.com/chargebee/chargebee-go/v3"
    customerAction "github.com/chargebee/chargebee-go/v3/actions/customer"
    "github.com/chargebee/chargebee-go/v3/models/customer"
    enum "github.com/chargebee/chargebee-go/v3/enum"
)
func main() {
    chargebee.Configure("{site_api_key}","{site}");
    res,err := customerAction.Hierarchy("foo", &customer.HierarchyRequestParams{
        HierarchyOperationType : enum.HierarchyOperationTypeSubordinates,
    }).Request()
    if err != nil {
        fmt.Println(err)
    } else {
        Hierarchies := res.Hierarchies
    }
}
```

#### Go

```go
package main

import (
  "fmt"
  "github.com/chargebee/chargebee-go/v4"
)

func main() {
  config := &chargebee.ClientConfig{
    SiteName: "{site}",
    ApiKey: "{site_api_key}",
  }    
  client := chargebee.NewClient(config)
  req := &chargebee.CustomerHierarchyRequest{
    HierarchyOperationType : chargebee.HierarchyOperationTypeSubordinates,
}
  res, err := client.Customer.Hierarchy("foo", req)
      if err != nil {
        fmt.Println(err)
    } else {
        Hierarchies := res.Hierarchies
    }
}
```

#### Java

```java
import com.chargebee.*;
import com.chargebee.ListResult;
import com.chargebee.models.*;
import com.chargebee.models.enums.*;
import java.io.IOException;
import java.util.List;

public class Sample {

    public static void main(String args[]) throws IOException, Exception {
        Environment.configure("{site}", "{site_api_key}");
        Result result = Customer.hierarchy("foo")
            .hierarchyOperationType(HierarchyOperationType.SUBORDINATES)
            .request();

        List<Hierarchy> hierarchies = result.hierarchies();
    }
}
```

#### Java

```java
import com.chargebee.v4.client.ChargebeeClient;
import com.chargebee.v4.models.customer.params.CustomerHierarchyParams;
import com.chargebee.v4.models.customer.responses.CustomerHierarchyResponse;
import com.chargebee.v4.models.hierarchy.Hierarchy;
import java.util.List;

public class CustomerHierarchy {

    public static void main(String[] args) {
        ChargebeeClient client = ChargebeeClient.builder()
            .apiKey("{site_api_key}")
            .siteName("{site}")
            .build();

        CustomerHierarchyParams params = CustomerHierarchyParams.builder()
            .hierarchyOperationType(CustomerHierarchyParams.HierarchyOperationType.SUBORDINATES)
            .build();

        CustomerHierarchyResponse response = client
            .customers()
            .hierarchy("foo", params);

        List<Hierarchy> hierarchies = response.getHierarchies();
    }
}
```

#### Node.js

```node
import Chargebee from "chargebee";

const chargebee = new Chargebee({
    site: "{site}",
    apiKey: "{site_api_key}",
});

try {
    const result = await chargebee.customer.hierarchy("foo", {
        hierarchy_operation_type: "subordinates"
    });

    console.log(result);
    const hierarchies = result.hierarchies;
} catch (err) {
    console.log(err);
}
```

#### PHP

```php
<?php

require __DIR__ . '/vendor/autoload.php';

use Chargebee\ChargebeeClient;

$chargebee = new ChargebeeClient(options: [
    "site" => "{site}",
    "apiKey" => "{site_api_key}",
]);
$result = $chargebee->customer()->hierarchy("foo", [
    "hierarchy_operation_type" => "subordinates"
]);
$hierarchies = $result->hierarchies;
```

#### Python

```python
import chargebee
from chargebee import Chargebee

cb_client = Chargebee(api_key="{site_api_key}", site="{site}")
response = cb_client.Customer.hierarchy("foo",
    cb_client.Customer.HierarchyParams(
        hierarchy_operation_type=chargebee.HierarchyOperationType.SUBORDINATES
    )
)
hierarchies = response.hierarchies
```

#### Ruby

```ruby
require 'chargebee'

ChargeBee.configure(:site => "{site}",
  :api_key => "{site_api_key}")

result = ChargeBee::Customer.hierarchy("foo",{
  :hierarchy_operation_type => "SUBORDINATES"
})

hierarchies = result.hierarchies
```

## Sample Response

```json
{
  "hierarchies": [
    {
      "children_ids": [
        "foo",
        {..}
      ],
      "payment_owner_id": "bar",
      "customer_id": "bar",
      "invoice_owner_id": "bar",
      "object": "hierarchy"
    },
    {..}
  ]
}
```

## URL Format

**GET** https://[site].chargebee.com/api/v2/customers/{customer-id}/hierarchy

## Input Parameters

- `hierarchy_operation_type` (required, enumerated string)
  Specifies which part of the account hierarchy to retrieve for the customer identified by `{"customer_id"}` .
  Possible enum values:
    - `complete_hierarchy`
    - `subordinates`
    - `path_to_root`

## Returns

- `hierarchies` (always returned)
  Resource object representing hierarchy