GET /customers

The device from which the customer has made the request

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.

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.

optional, enumerated string filter

Specifies if the customer is liable for tax. Possible values are : taxable, exempt.

Supported operators : is, is_not, in, not_in

Example → taxability[is] = "taxable"

optional, string filter

First name of the customer. Supported operators : is, is_not, starts_with, is_present

Example → first_name[is] = "John"

optional, string filter

The 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_with

Example → business_entity_id[is_not] = "business_entity_id"

Parameters for relationship

optional, boolean filter

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. Possible values are : true, false

Supported operators : is

Example → auto_close_invoices[is] = "true"

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

optional, timestamp(UTC) in seconds filter

To 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, between

Example → updated_at[after] = "1243545465"

optional, string filter

Identifier of the customer. Supported operators : is, is_not, starts_with, in, not_in

Example → id[is] = "9bsvnHgsvmsI"

optional, enumerated string filter

The 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_in

Example → offline_payment_method[is] = "cash"

The number of resources to be returned.

Default value: 10

optional, string filter

Email of the customer. Configured email notifications will be sent to this email. Supported operators : is, is_not, starts_with, is_present

Example → email[is] = "john@test.com"

optional, enumerated string filter

The 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_in

Example → channel[is] = "APP STORE"

optional, string filter

Last name of the customer. Supported operators : is, is_not, starts_with, is_present

Example → last_name[is] = "Clint"

optional, string filter

Company name of the customer. Supported operators : is, is_not, starts_with, is_present

Example → company[is_not] = "Globex Corp"

optional, string filter

Phone number of the customer. Supported operators : is, is_not, starts_with, is_present

Example → phone[is_not] = "(541) 754-3010"

optional, enumerated string filter

Whether payments needs to be collected automatically for this customer. Possible values are : on, off.

Supported operators : is, is_not, in, not_in

Example → auto_collection[is] = "on"

optional, timestamp(UTC) in seconds filter

Timestamp indicating when this customer resource is created. Supported operators : after, before, on, between

Example → created_at[before] = "1435054328"

optional, string filter

Sorts based on the specified attribute. Supported attributes : created_at, updated_at

Supported sort-orders : asc, desc

Example → sort_by[asc] = "created_at"

This will sort the result based on the 'created_at' attribute in ascending(earliest first) order.

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.