Update account hierarchy access settings for a customer

Idempotency Supported

When the customer is part of an account hierarchy, this operation updates the access privileges that both the customer and its parent have to the customer's data.

Terminology The term "parent" usually refers to the customer with the ID payment_owner_id. However, if the payment_owner_id is the same as the child's ID (given by the path parameter), the "parent" is identified by parent_id.

Tip You cannot use this endpoint to change the parent_id, invoice_owner_id or payment_owner_id for the customer. To change them, unlink the customer and then call Link a customer with the updated values.

Sample Request

URL Format

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

Input Parameters

use_default_hierarchy_settings

optional, boolean, default=true

Decides if Chargebee should apply settings from the Chargebee Billing UI or from this API request.

If set to true: Chargebee removes existing settings stored in the parent_account_access and child_account_access attributes of the customer. The settings configured in the Chargebee Billing UI apply for the customer.
If set to false: Chargebee replaces existing settings stored in the parent_account_access and child_account_access parameters with those passed in this API call. If any of those parameters are not passed, they remain unchanged for the customer.

parent_account_access

optional, enumerated string

Parameters for parent_account_access

child_account_access

optional, enumerated string

When the customer is part of an account hierarchy , this attribute defines the level of access that the customer has to its own information.

Returns

customerCustomer object

Resource object representing customer