Updates the details of the specified customer.
Use this API to modify customer information, including standard attributes and any configured custom attributes.
- To update the billing address or VAT number, use the Update billing info for a customer API instead.
- The Account Hierarchy (Parent-Child Relationship) cannot be updated using this API.
- To add a child to a Parent Account, use the Link a customer to an account API.
- To remove a child from a Parent Account, use the Unlink a customer from its parent account API.
Impacts
Invoices
- See
auto_collectionparameter to understand the impact on invoices. - See
taxabilityparameter to understand how taxes on invoices are impacted.
CRM integrations
When you update customer details in Chargebee using this API, the corresponding records are synced with integrated CRM systems, such as HubSpot or Salesforce, depending on your integration configuration.
Sample Request
URL Format
Input Parameters
Email of the customer. Configured email notifications will be sent to this email.
The currency code (ISO 4217 format) of the customer. Applicable if Multicurrency is enabled.
Determines whether payments should be collected automatically for this customer.
Note This setting can be overridden at the subscription level.
Payments are automatically collected for new invoices. For existing invoices, Chargebee attempts collections through dunning as per the configured schedule.
Payments are not automatically collected for this customer.
The number of days within which the customer has to make payment for the invoice.
Specifies whether taxes are applicable to invoices generated for this customer.
Taxes are calculated for this customer based on the site's tax configuration. In some regions, shipping_address is required for tax computation. If a shipping address is not provided, the billing_address is used. If neither address is available, no tax is applied.
The customer is exempt from tax.
- If you use Chargebee Taxes or the TaxJar integration, no additional action is required.
- If you use the Avalara integration, optionally specify the
entity_codeorexempt_numberattributes with AvaTax for Sales, or theexemption_detailsattribute with AvaTax for Communications. Avalara may still apply tax depending on the values ofentity_code,exempt_number, orexemption_details, and the jurisdiction (state, region, or province) of the taxable address.
Indicates the exemption information. You can customize customer exemption based on specific Location, Tax level (Federal, State, County and Local), Category of Tax or specific Tax Name. This is applicable only if you use Chargebee's AvaTax for Communications integration. To know more about what values you need to provide, refer to this Avalara's API document .
Indicates the type of the customer. This is applicable only if you use Chargebee's AvaTax for Communications integration.
When the purchase is made by a customer for home use
When the purchase is made at a place of business
When the purchase is made by a customer who meets the jurisdiction requirements to be considered a senior citizen and qualifies for senior citizen tax breaks
When the purchase is made by an industrial business
Indicates the Client profile id for the customer. This is applicable only if you use Chargebee's AvaTax for Communications integration.
Indicates the exemption type of the customer. This is applicable only if you use Chargebee's TaxJar integration.
Whole-sale
Government
Other
Determines which region-specific language Chargebee uses to communicate with the customer. In the absence of the locale attribute, Chargebee will use your site's default language for customer communication.
The exemption category of the customer, for USA and Canada. Applicable if you use Chargebee's AvaTax for Sales integration .
Federal government
State government
Tribe/Status Indian/Indian Band
Foreign diplomat
Charitable or benevolent organization
Any string value that will cause the sale to be exempted. Use this if your finance team manually verifies and tracks exemption certificates. Applicable if you use Chargebee's AvaTax for Sales integration .
The preferred offline payment method for the customer.
No Preference
Cash
Check
Bank Transfer
ACH Credit
A customer-facing note added to all invoices associated with this API resource. This note becomes one among all the notes displayed on the invoice PDF.
Override for this customer, the site-level setting for auto-closing invoices. Only applicable when auto-closing invoices has been enabled for the site. This attribute is also available at the subscription level which takes precedence.
A collection of key-value pairs that provides extra information about the customer.
Note: There's a character limit of 65,535.
Indicates whether or not the customer has been identified as fraudulent.
The customer has been marked as safe
The customer has been marked as fraudulent
Indicates whether invoices raised on the same day for the customer are consolidated. When provided, this overrides the default configuration at the site-level. This parameter can be provided only when Consolidated Invoicing is enabled.
Note:
Any invoices raised when a subscription activates from in_trial or future status, are not consolidated by default. Contact Support to enable consolidation for such invoices.
.