GET /customers

Retrieves a list of customers added to your Chargebee site. The list contains the necessary customer details such as First Name, Last Name and the Customer ID.

Servers

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

Request headers

Name	Type	Required	Description
`chargebee-request-origin-device`	String	No	The device from which the customer has made the request
`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-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.

Query parameters

Name	Type	Required	Description
`taxability`	Object	No	optional, enumerated string filterSpecifies if the customer is liable for tax. Possible values are : taxable, exempt.Supported operators : is, is_not, in, not_inExample → taxability[is] = "taxable"
`first_name`	Object	No	optional, string filterFirst name of the customer.Supported operators : is, is_not, starts_with, is_presentExample → first_name[is] = "John"
`business_entity_id`	Object	No	optional, string filterThe unique ID of the business entity of this subscription. This is always the same as the business entity of the customer. Supported operators : is, is_not, starts_withExample → business_entity_id[is_not] = "business_entity_id"
`relationship`	Object	No	Parameters for relationship
`auto_close_invoices`	Object	No	optional, boolean filterOverride 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. Possible values are : true, false Supported operators : isExample → auto_close_invoices[is] = "true"
`include_deleted`	Boolean	No	If set to true, includes the deleted resources in the response. For the deleted resources in the response, the 'deleted ' attribute will be 'true'. Default value: false
`updated_at`	Object	No	optional, timestamp(UTC) in seconds filterTo filter based on `updated_at`. This attribute will be present only if the resource has been updated after 2016-09-28. It is advisable when using this filter, to pass the `sort_by` input parameter as `updated_at` for a faster response.Supported operators : after, before, on, betweenExample → updated_at[after] = "1243545465"
`id`	Object	No	optional, string filterIdentifier of the customer.Supported operators : is, is_not, starts_with, in, not_inExample → id[is] = "9bsvnHgsvmsI"
`offline_payment_method`	Object	No	optional, enumerated string filterThe preferred offline payment method for the customer. Possible values are : no_preference, cash, check, bank_transfer, ach_credit, sepa_credit.Supported operators : is, is_not, in, not_inExample → offline_payment_method[is] = "cash"
`limit`	Integer	No	The number of resources to be returned. Default value: 10
`email`	Object	No	optional, string filterEmail of the customer. Configured email notifications will be sent to this email.Supported operators : is, is_not, starts_with, is_presentExample → email[is] = "john@test.com"
`channel`	Object	No	optional, enumerated string filterThe subscription channel this object originated from and is maintained in. Possible values are : web, app_store, play_store.Supported operators : is, is_not, in, not_inExample → channel[is] = "APP STORE"
`last_name`	Object	No	optional, string filterLast name of the customer.Supported operators : is, is_not, starts_with, is_presentExample → last_name[is] = "Clint"
`company`	Object	No	optional, string filterCompany name of the customer.Supported operators : is, is_not, starts_with, is_presentExample → company[is_not] = "Globex Corp"
`phone`	Object	No	optional, string filterPhone number of the customer.Supported operators : is, is_not, starts_with, is_presentExample → phone[is_not] = "(541) 754-3010"
`auto_collection`	Object	No	optional, enumerated string filterWhether payments needs to be collected automatically for this customer. Possible values are : on, off.Supported operators : is, is_not, in, not_inExample → auto_collection[is] = "on"
`created_at`	Object	No	optional, timestamp(UTC) in seconds filterTimestamp indicating when this customer resource is created.Supported operators : after, before, on, betweenExample → created_at[before] = "1435054328"
`sort_by`	Object	No	optional, string filterSorts based on the specified attribute. Supported attributes : created_at, updated_atSupported sort-orders : asc, descExample → sort_by[asc] = "created_at"This will sort the result based on the 'created_at' attribute in ascending(earliest first) order.
`offset`	String	No	Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set `offset` to the value of `next_offset` obtained in the previous iteration of the API call.

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.