GET /customers/{customer-id}/hierarchy

Retrieves the full or partial account hierarchy for a 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
`hierarchy_operation_type`	String	Yes	Specifies which part of the account hierarchy to retrieve for the customer identified by `{customer_id}`. complete_hierarchy - Retrieve all nodes in the account hierarchy. subordinates - Retrieve all nodes in the account hierarchy that start from the specified customer (identified by `{customer_id}`) and include its subordinates. In other words, get nodes in the account hierarchy tree where the root node is the specified customer. subordinates_with_unbilled_charges_payable_by_parent - List all the nodes of the hierarchy formed by its subordinates with unbilled charges whose payment owner is the customer. path_to_root - Retrieve nodes from the specified customer (identified by `{customer_id}`) to the root of its account hierarchy. Possible values: `"path_to_root"` `"subordinates"` `"complete_hierarchy"`

hierarchy_operation_type

String

Yes

Specifies which part of the account hierarchy to retrieve for the customer identified by {customer_id}.

complete_hierarchy - Retrieve all nodes in the account hierarchy.
subordinates - Retrieve all nodes in the account hierarchy that start from the specified customer (identified by {customer_id}) and include its subordinates. In other words, get nodes in the account hierarchy tree where the root node is the specified customer.
subordinates_with_unbilled_charges_payable_by_parent - List all the nodes of the hierarchy formed by its subordinates with unbilled charges whose payment owner is the customer.
path_to_root - Retrieve nodes from the specified customer (identified by {customer_id}) to the root of its account hierarchy.

Possible values:

"path_to_root"
"subordinates"
"complete_hierarchy"

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