POST /customers/{customer-id}/update_hierarchy_settings

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.

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
`Content-Type`	String	Yes	The media type of the request body. Default value: "application/x-www-form-urlencoded"
`chargebee-event-webhook`	String	No	skip only webhooks Valid values: `"all-disabled"`
`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-event-actions`	String	No	skip all actions to be done on the events Valid values: `"all-disabled"`
`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.
`chargebee-event-email`	String	No	skip only emails Valid values: `"all-disabled"`

Request body fields

Name	Type	Required	Description
`use_default_hierarchy_settings`	Boolean	No	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. Default value: true
`child_account_access`	Object	No	When the customer is part of an [account hierarchy](https://www.chargebee.com/docs/account-hierarchy.html), this attribute defines the level of access that the customer has to its own information.
`child_account_access.send_subscription_emails`	Boolean	No	If `true`, the child account receives email notifications for its subscriptions.
`child_account_access.send_invoice_emails`	Boolean	No	If `true`, the child account receives email notifications for its invoices.
`child_account_access.portal_edit_subscriptions`	String	No	Determines the child's access to its own subscriptions in the Self-Serve Portal. * view_only - The child account can only view its subscriptions. * yes - The child account can view and edit its subscriptions. Valid values: `"yes"` `"view_only"`
`child_account_access.portal_download_invoices`	String	No	Determines the child's access to its own invoices in the Self-Serve Portal. * view_only - The child account can view but not download its invoices. * no - The child account cannot view or download its own invoices. * yes - The child account can both view and download its invoices. Valid values: `"yes"` `"view_only"` `"no"`
`child_account_access.send_payment_emails`	Boolean	No	If `true`, the child account receives email notifications for payment-related activities for its invoices.
`parent_account_access`	Object	No	Parameters for parent_account_access
`parent_account_access.portal_download_child_invoices`	String	No	Sets parent's level of access to child invoices on the Self-Serve Portal. * yes - The parent account can view and download the invoices of the child account. * no - The parent account can neither view nor download the invoices of the child account. * view_only - The parent account can only view the invoices of the child account. Valid values: `"yes"` `"view_only"` `"no"`
`parent_account_access.send_subscription_emails`	Boolean	No	If `true`, the parent account will receive subscription-related emails sent to the child account.
`parent_account_access.send_invoice_emails`	Boolean	No	If `true`, the parent account will receive invoice-related emails sent to the child account.
`parent_account_access.portal_edit_child_subscriptions`	String	No	Sets parent's level of access to child subscriptions on the Self-Serve Portal. * yes - The parent account can view and edit the subscriptions of the child account. * no - The parent account cannot view or edit the subscriptions of the child account. * view_only - The parent account can only view the subscriptions of the child account. Valid values: `"yes"` `"view_only"` `"no"`
`parent_account_access.send_payment_emails`	Boolean	No	If `true`, the parent account will receive payment-related emails sent to the child account.

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.