POST /customers/{customer-id}

Updates the customer resource. However this method cannot be used for updating the 'Billing Info' - the Billing Address and 'vat_number' attributes - of the customer. To update the same, use our Update Billing Info API.

Servers

{protocol}://{site}.{environment}:{port}/api/v1
{protocol}://{site}-test.{environment}:{port}/api/v1

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 Possible values: `"all-disabled"`
`chargebee-event-actions`	String	No	skip all actions to be done on the events Possible 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 Possible values: `"all-disabled"`

Request body fields

Name	Type	Required	Description
`taxability`	String	No	Specifies if the customer is liable for tax. * 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. * 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. Possible values: `"exempt"` `"taxable"` Default value: "taxable"
`email`	String	No	Email of the customer. Configured email notifications will be sent to this email.
`last_name`	String	No	Last name of the customer.
`company`	String	No	Company name of the customer.
`meta_data`	Object	No	A set of key-value pairs stored as additional information for the customer. [Learn more](./#meta_data).
`first_name`	String	No	First name of the customer.
`phone`	String	No	Phone number of the customer.
`auto_collection`	String	No	Whether payments needs to be collected automatically for this customer. * off - Automatic collection of charges will not be made. All payments must be recorded offline. * on - Whenever an invoice is created, an automatic attempt to charge the customer's payment method is made. Possible values: `"on"` `"off"` Default value: "on"
`invoice_notes`	String	No	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.
`allow_direct_debit`	Boolean	No	Whether the customer can pay via Direct Debit. Default value: false

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.