POST /customers/{customer-id}

The device from which the customer has made the request

Default value: "application/x-www-form-urlencoded"

skip only webhooks

Possible values:

• "all-disabled"

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.

skip all actions to be done on the events

Possible values:

• "all-disabled"

The email address of your customer/user. Use this when the email address has only ASCII characters.

The IP address of the customer where the request originated

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.

skip only emails

Possible values:

• "all-disabled"

Specifies if the customer is liable for tax. * taxable - Computes tax for the customer based on the site configuration. In some cases, depending on the region, shipping_address is needed. If not provided, then billing_address is used to compute tax. If that's not available either, the tax is taken as zero. * exempt -

• Customer is exempted from tax. When using Chargebee's native Taxes feature or when using the TaxJar integration, no other action is needed.
• However, when using our Avalara integration, optionally, specify entity_code or exempt_number attributes if you use Chargebee's AvaTax for Sales or specify exemption_details attribute if you use Chargebee's AvaTax for Communications integration. Tax may still be applied by Avalara for certain values of entity_code/exempt_number/exemption_details based on the state/region/province of the taxable address.

Possible values:

• "exempt"
• "taxable"

Default value: "taxable"

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. .

The exemption category of the customer, for USA and Canada. Applicable if you use Chargebee's AvaTax for Sales integration. * med2 - US Medical Device Excise Tax with taxable sales tax * med1 - US Medical Device Excise Tax with exempt sales tax * d - Foreign diplomat * e - Charitable or benevolent organization * f - Religious organization * g - Resale * a - Federal government * b - State government * c - Tribe/Status Indian/Indian Band * l - Other or custom * m - Educational organization * n - Local government * h - Commercial agricultural production * i - Industrial production/manufacturer * j - Direct pay permit * k - Direct mail * p - Commercial aquaculture * q - Commercial Fishery * r - Non-resident

Possible values:

• "d"
• "c"
• "b"
• "a"
• "med2"
• "med1"
• "r"
• "q"
• "p"
• "n"
• "m"
• "l"
• "k"
• "j"
• "i"
• "h"
• "g"
• "f"
• "e"

A collection of key-value pairs that provides extra information about the customer. **Note:** There's a character limit of 65,535. [Learn more](advanced-features?prod_cat_ver=2#metadata).

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.

First name of the customer.

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 whether or not the customer has been identified as fraudulent. * fraudulent - The customer has been marked as fraudulent * suspicious - The customer has been identified as potentially fraudulent by the gateway * safe - The customer has been marked as safe

Possible values:

• "safe"
• "fraudulent"

Indicates the type of the customer. This is applicable only if you use Chargebee's AvaTax for Communications integration. * senior_citizen - 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 * industrial - When the purchase is made by an industrial business * business - When the purchase is made at a place of business * residential - When the purchase is made by a customer for home use

Possible values:

• "residential"
• "business"
• "senior_citizen"
• "industrial"

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.

Whether the customer can pay via Direct Debit.

Default value: false

Indicates the Client profile id for the customer. This is applicable only if you use Chargebee's AvaTax for Communications integration.

The preferred offline payment method for the customer. * custom - Custom * bank_transfer - Bank Transfer * boleto - Boleto * jp_automated_bank_transfer - JP Automated Bank Transfer * sepa_credit - SEPA Credit * cash - Cash * check - Check * mx_automated_bank_transfer - MX Automated Bank Transfer * no_preference - No Preference * us_automated_bank_transfer - US Automated Bank Transfer * eu_automated_bank_transfer - EU Automated Bank Transfer * ach_credit - ACH Credit * uk_automated_bank_transfer - UK Automated Bank Transfer

Possible values:

• "mx_automated_bank_transfer"
• "cash"
• "boleto"
• "no_preference"
• "bank_transfer"
• "jp_automated_bank_transfer"
• "custom"
• "check"
• "eu_automated_bank_transfer"
• "sepa_credit"
• "ach_credit"
• "us_automated_bank_transfer"
• "uk_automated_bank_transfer"

Email of the customer. Configured email notifications will be sent to this email.

The number of days within which the customer has to make payment for the invoice. .

Default value: 0

Last name of the customer.

Company name of the customer.

Phone number of the customer.

Parameters for tax_providers_fields

The value of the related tax field

Field id of the attribute which tax vendor has provided while getting onboarded with Chargebee.

Name of the tax provider.

Whether payments needs to be collected automatically for this customer. * on - Whenever an invoice is created, an automatic attempt to charge the customer's payment method is made. * off - Automatic collection of charges will not be made. All payments must be recorded offline.

Possible values:

• "on"
• "off"

Default value: "on"

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 currency code (ISO 4217 format) of the customer. Applicable if Multicurrency is enabled.

Indicates the exemption type of the customer. This is applicable only if you use Chargebee's TaxJar integration. * government - Government * other - Other * wholesale - Whole-sale

Possible values:

• "other"
• "wholesale"
• "government"