Get paginated account hierarchy for a customer

Retrieves the account hierarchy tree for the customer.

Sample Request

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

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

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

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

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.

Enum Values

complete_hierarchy

subordinates

path_to_root

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 object

Resource object representing hierarchy