GET /customers/{customer-id}/hierarchy_detail

Retrieves the account hierarchy tree for the customer.

Servers

{protocol}://{site}.{environment}:{port}/api/v2
{protocol}://{site}-test.{environment}:{port}/api/v2

Path parameters

Name	Type	Required	Description
`customer-id`	String	Yes

Request headers

Name	Type	Required	Description
`chargebee-request-origin-device`	String	No	The device from which the customer has made the request
`chargebee-business-entity-id`	String	No	If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.
`chargebee-request-origin-user`	String	No	The email address of your customer/user. Use this when the email address has only ASCII characters.
`chargebee-request-origin-ip`	String	No	The IP address of the customer where the request originated
`chargebee-request-origin-user-encoded`	String	No	The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header `chargebee-request-origin-user` is ignored.

Query parameters

Name Type Required Description

Name	Type	Required	Description
`limit`	Integer	No	The number of resources to be returned. Default value: 10
`hierarchy_operation_type`	String	Yes	Specifies which part of the hierarchy to fetch. Choose from the available operation types. complete_hierarchy - Fetches all nodes in the full hierarchy that the customer belongs to. subordinates - Fetches all nodes in the sub-hierarchy rooted at the customer, including the customer and its subordinates. subordinates_with_unbilled_charges_payable_by_parent - Fetches subordinate nodes with unbilled charges for which the customer is the payment owner. path_to_root - Fetches a list of nodes along the path from the customer to the root of the hierarchy. Possible values: `"path_to_root"` `"subordinates"` `"complete_hierarchy"`
`offset`	String	No	Used for pagination. Set this to the `next_offset` value from the previous API response to fetch the next page.

limit

Integer

No

The number of resources to be returned.

Default value: 10

hierarchy_operation_type

String

Yes

Specifies which part of the hierarchy to fetch. Choose from the available operation types.

complete_hierarchy - Fetches all nodes in the full hierarchy that the customer belongs to.
subordinates - Fetches all nodes in the sub-hierarchy rooted at the customer, including the customer and its subordinates.
subordinates_with_unbilled_charges_payable_by_parent - Fetches subordinate nodes with unbilled charges for which the customer is the payment owner.
path_to_root - Fetches a list of nodes along the path from the customer to the root of the hierarchy.

Possible values:

"path_to_root"
"subordinates"
"complete_hierarchy"

offset

String

No

Used for pagination. Set this to the next_offset value from the previous API response to fetch the next page.

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.

All third party trademarks (including logos and icons) are the property of their respective owners, which do not sponsor, authorize, or endorse this website.

Pricing Templates Integrations Blog Contact Us Help

Terms of Service Privacy Policy