# Get paginated account hierarchy for a customer

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


[Eventually Consistent](/docs/api/read-consistency)

Retrieves the [account hierarchy tree](/docs/api/hierarchies) for the 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/east_outlet/hierarchy_detail \
     -G  \
     -u {site_api_key}:\
     --data-urlencode hierarchy_operation_type="COMPLETE_HIERARCHY" \
     --data-urlencode limit=2
```

#### .NET

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

ApiConfig.Configure("{site}","{site_api_key}");
ListResult result = Customer.ListHierarchyDetail("east_outlet")
		.HierarchyOperationType(HierarchyOperationTypeEnum.CompleteHierarchy)
		.Limit(2)
		.Request();

foreach (var listItem in result.List){
  Hierarchy hierarchy = listItem.Hierarchy;
}
```

#### 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.ListHierarchyDetail("east_outlet", &customer.ListHierarchyDetailRequestParams{
        HierarchyOperationType : enum.HierarchyOperationTypeCompleteHierarchy,
        Limit : chargebee.Int32(2),
    }).ListRequest()
    if err != nil {
        fmt.Println(err)
    } else {
        for idx := 0; idx < len(res.List); idx++ {
            Hierarchy := res.List[idx].Hierarchy
        }
    }
}
```

#### 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.CustomerListHierarchyDetailRequest{
    HierarchyOperationType : chargebee.HierarchyOperationTypeCompleteHierarchy,
    Limit : chargebee.Int32(2),
}
  res, err := client.Customer.ListHierarchyDetail("east_outlet", req)
      if err != nil {
        fmt.Println(err)
    } else {
        for idx := 0; idx < len(res.List); idx++ {
            Hierarchy := res.List[idx].Hierarchy
        }
    }
}
```

#### 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}");
        ListResult result = Customer.listHierarchyDetail("east_outlet")
            .hierarchyOperationType(HierarchyOperationType.COMPLETE_HIERARCHY)
            .limit(2)
            .request();

        for (ListResult.Entry entry : result) {
            Hierarchy hierarchy = entry.hierarchy();
        }
    }
}
```

#### Java

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

public class CustomerListHierarchyDetail {

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

        CustomerListHierarchyDetailParams params = CustomerListHierarchyDetailParams.builder()
            .hierarchyOperationType(CustomerListHierarchyDetailParams.HierarchyOperationType.COMPLETE_HIERARCHY)
            .limit(2)
            .build();

        CustomerListHierarchyDetailResponse response = client
            .customers()
            .listHierarchyDetail("east_outlet", params);
    }
}
```

#### Node.js

```node
import Chargebee from "chargebee";

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

try {
    const result = await chargebee.customer.listHierarchyDetail("east_outlet", {
        hierarchy_operation_type: "complete_hierarchy",
        limit: 2
    });
    result.list.forEach((entry) => {
        console.log(entry);
        const hierarchy = entry.hierarchy;
    });
} 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()->listHierarchyDetail("east_outlet", [
    "hierarchy_operation_type" => "complete_hierarchy",
    "limit" => 2
]);
foreach($result->list as $entry) {
    $hierarchy = $entry->hierarchy;
}
```

#### Python

```python
import chargebee
from chargebee import Chargebee, Filters

cb_client = Chargebee(api_key="{site_api_key}", site="{site}")
entries = cb_client.Customer.list_hierarchy_detail("east_outlet",
    cb_client.Customer.ListHierarchyDetailParams(
        hierarchy_operation_type=chargebee.HierarchyOperationType.COMPLETE_HIERARCHY,
        limit=2
    )
)
for entry in entries.list:
    hierarchy = entry.hierarchy
```

#### Ruby

```ruby
require 'chargebee'

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

list = ChargeBee::Customer.list_hierarchy_detail("east_outlet",{
  :hierarchy_operation_type => "COMPLETE_HIERARCHY",
  :limit => 2
})

list.each do |entry|
  hierarchy = entry.hierarchy
end
```

### 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/east_outlet/hierarchy_detail \
     -G  \
     -u {site_api_key}:\
     --data-urlencode hierarchy_operation_type="PATH_TO_ROOT" \
     --data-urlencode limit=2
```

#### .NET

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

ApiConfig.Configure("{site}","{site_api_key}");
ListResult result = Customer.ListHierarchyDetail("east_outlet")
		.HierarchyOperationType(HierarchyOperationTypeEnum.PathToRoot)
		.Limit(2)
		.Request();

foreach (var listItem in result.List){
  Hierarchy hierarchy = listItem.Hierarchy;
}
```

#### 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.ListHierarchyDetail("east_outlet", &customer.ListHierarchyDetailRequestParams{
        HierarchyOperationType : enum.HierarchyOperationTypePathToRoot,
        Limit : chargebee.Int32(2),
    }).ListRequest()
    if err != nil {
        fmt.Println(err)
    } else {
        for idx := 0; idx < len(res.List); idx++ {
            Hierarchy := res.List[idx].Hierarchy
        }
    }
}
```

#### 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.CustomerListHierarchyDetailRequest{
    HierarchyOperationType : chargebee.HierarchyOperationTypePathToRoot,
    Limit : chargebee.Int32(2),
}
  res, err := client.Customer.ListHierarchyDetail("east_outlet", req)
      if err != nil {
        fmt.Println(err)
    } else {
        for idx := 0; idx < len(res.List); idx++ {
            Hierarchy := res.List[idx].Hierarchy
        }
    }
}
```

#### 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}");
        ListResult result = Customer.listHierarchyDetail("east_outlet")
            .hierarchyOperationType(HierarchyOperationType.PATH_TO_ROOT)
            .limit(2)
            .request();

        for (ListResult.Entry entry : result) {
            Hierarchy hierarchy = entry.hierarchy();
        }
    }
}
```

#### Java

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

public class CustomerListHierarchyDetail {

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

        CustomerListHierarchyDetailParams params = CustomerListHierarchyDetailParams.builder()
            .hierarchyOperationType(CustomerListHierarchyDetailParams.HierarchyOperationType.PATH_TO_ROOT)
            .limit(2)
            .build();

        CustomerListHierarchyDetailResponse response = client
            .customers()
            .listHierarchyDetail("east_outlet", params);
    }
}
```

#### Node.js

```node
import Chargebee from "chargebee";

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

try {
    const result = await chargebee.customer.listHierarchyDetail("east_outlet", {
        hierarchy_operation_type: "path_to_root",
        limit: 2
    });
    result.list.forEach((entry) => {
        console.log(entry);
        const hierarchy = entry.hierarchy;
    });
} 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()->listHierarchyDetail("east_outlet", [
    "hierarchy_operation_type" => "path_to_root",
    "limit" => 2
]);
foreach($result->list as $entry) {
    $hierarchy = $entry->hierarchy;
}
```

#### Python

```python
import chargebee
from chargebee import Chargebee, Filters

cb_client = Chargebee(api_key="{site_api_key}", site="{site}")
entries = cb_client.Customer.list_hierarchy_detail("east_outlet",
    cb_client.Customer.ListHierarchyDetailParams(
        hierarchy_operation_type=chargebee.HierarchyOperationType.PATH_TO_ROOT,
        limit=2
    )
)
for entry in entries.list:
    hierarchy = entry.hierarchy
```

#### Ruby

```ruby
require 'chargebee'

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

list = ChargeBee::Customer.list_hierarchy_detail("east_outlet",{
  :hierarchy_operation_type => "PATH_TO_ROOT",
  :limit => 2
})

list.each do |entry|
  hierarchy = entry.hierarchy
end
```

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

#### cURL

```bash
curl  https://{site}.chargebee.com/api/v2/customers/north_division/hierarchy_detail \
     -G  \
     -u {site_api_key}:\
     --data-urlencode hierarchy_operation_type="SUBORDINATES" \
     --data-urlencode limit=2
```

#### .NET

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

ApiConfig.Configure("{site}","{site_api_key}");
ListResult result = Customer.ListHierarchyDetail("north_division")
		.HierarchyOperationType(HierarchyOperationTypeEnum.Subordinates)
		.Limit(2)
		.Request();

foreach (var listItem in result.List){
  Hierarchy hierarchy = listItem.Hierarchy;
}
```

#### 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.ListHierarchyDetail("north_division", &customer.ListHierarchyDetailRequestParams{
        HierarchyOperationType : enum.HierarchyOperationTypeSubordinates,
        Limit : chargebee.Int32(2),
    }).ListRequest()
    if err != nil {
        fmt.Println(err)
    } else {
        for idx := 0; idx < len(res.List); idx++ {
            Hierarchy := res.List[idx].Hierarchy
        }
    }
}
```

#### 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.CustomerListHierarchyDetailRequest{
    HierarchyOperationType : chargebee.HierarchyOperationTypeSubordinates,
    Limit : chargebee.Int32(2),
}
  res, err := client.Customer.ListHierarchyDetail("north_division", req)
      if err != nil {
        fmt.Println(err)
    } else {
        for idx := 0; idx < len(res.List); idx++ {
            Hierarchy := res.List[idx].Hierarchy
        }
    }
}
```

#### 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}");
        ListResult result = Customer.listHierarchyDetail("north_division")
            .hierarchyOperationType(HierarchyOperationType.SUBORDINATES)
            .limit(2)
            .request();

        for (ListResult.Entry entry : result) {
            Hierarchy hierarchy = entry.hierarchy();
        }
    }
}
```

#### Java

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

public class CustomerListHierarchyDetail {

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

        CustomerListHierarchyDetailParams params = CustomerListHierarchyDetailParams.builder()
            .hierarchyOperationType(CustomerListHierarchyDetailParams.HierarchyOperationType.SUBORDINATES)
            .limit(2)
            .build();

        CustomerListHierarchyDetailResponse response = client
            .customers()
            .listHierarchyDetail("north_division", params);
    }
}
```

#### Node.js

```node
import Chargebee from "chargebee";

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

try {
    const result = await chargebee.customer.listHierarchyDetail("north_division", {
        hierarchy_operation_type: "subordinates",
        limit: 2
    });
    result.list.forEach((entry) => {
        console.log(entry);
        const hierarchy = entry.hierarchy;
    });
} 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()->listHierarchyDetail("north_division", [
    "hierarchy_operation_type" => "subordinates",
    "limit" => 2
]);
foreach($result->list as $entry) {
    $hierarchy = $entry->hierarchy;
}
```

#### Python

```python
import chargebee
from chargebee import Chargebee, Filters

cb_client = Chargebee(api_key="{site_api_key}", site="{site}")
entries = cb_client.Customer.list_hierarchy_detail("north_division",
    cb_client.Customer.ListHierarchyDetailParams(
        hierarchy_operation_type=chargebee.HierarchyOperationType.SUBORDINATES,
        limit=2
    )
)
for entry in entries.list:
    hierarchy = entry.hierarchy
```

#### Ruby

```ruby
require 'chargebee'

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

list = ChargeBee::Customer.list_hierarchy_detail("north_division",{
  :hierarchy_operation_type => "SUBORDINATES",
  :limit => 2
})

list.each do |entry|
  hierarchy = entry.hierarchy
end
```

## Sample Response

```json
{
  "list": [
    {
      "hierarchy": {
        "object": "hierarchy",
        "customer_id": "alpha_group",
        "payment_owner_id": "alpha_group",
        "invoice_owner_id": "alpha_group",
        "has_children": true
      }
    },
    {..}
  ],
  "next_offset": "[421503]"
}
```

## URL Format

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

## Input Parameters

- `limit` (optional, integer, default=10, min=1, max=100)
  The number of resources to be returned.

- `offset` (optional, string, max chars=1000)
  Used for pagination. Set this to the `next_offset` value from the previous API response to fetch the next page.

- `hierarchy_operation_type` (required, enumerated string)
  Specifies which part of the hierarchy to fetch. Choose from the available operation types.
  Possible enum values:
    - `complete_hierarchy`
    - `subordinates`
    - `path_to_root`

## Returns

- `next_offset` (optional, string, max chars=1000)
  This attribute is returned only if more resources are present. To fetch the next set of resources use this value for the input parameter `offset`.

- `hierarchy` (Hierarchy object)
  Resource object representing hierarchy