ChargebeeAPI

Hierarchies

When a customer belongs to an account hierarchy, the hierarchy resource represents the customer's position within that hierarchy. The hierarchy provides details about the customer's parent, children, invoice owner, and payment owner.

Note

  • A customer can have a maximum of 250 direct children.
  • The hierarchy allows a maximum of 5 levels from the root node to the lowest child node.

Related Endpoints

Sample HierarchyJSON

API Index URL

https://[site].chargebee.com/api/v2/hierarchies

Hierarchies attributes

customer_id
required, string, max chars=50

The id of the customer associated with this hierarchy resource.

parent_id
optional, string, max chars=50

The id of the immediate parent for the customer identified by customer_id. If the customer is the root of the hierarchy, this attribute isn't returned.

payment_owner_id
required, string, max chars=50

The id of the customer responsible for paying the invoices for the customer identified by customer_id. This ID must match either customer_id or invoice_owner_id .

invoice_owner_id
required, string, max chars=50

The id of the customer who receives the invoice for charges incurred by the customer identified by customer_id. This ID must match either customer_id or one of its ancestors.

has_children
optional, boolean

Indicates whether the customer has child accounts in the hierarchy.

children_ids
optional, string, max chars=50

A list of id s representing the immediate children, if any exist, for the customer identified by customer_id .