List Customers

List customers

GET/customers

Use it in a workflow

Add a step and choose the Chargebee connector.
Pick the List Customers action (under Chargebee API).
Fill in the fields below, then reference the result from later steps as {{listCustomers.response.data}}.

Request

Query parameters

limitinteger (int32)

The number of resources to be returned.

Default 10

offsetstring

Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">offset</code> to the value of <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">next_offset</code> obtained in the previous iteration of the API call.

include_deletedboolean

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 false

idobject

optional, string filter Identifier of the customer. **Supported operators :** is, is_not, starts_with, in, not_in **Example →** *id\[is\] = "9bsvnHgsvmsI"*

isstring

is_notstring

starts_withstring

instring

not_instring

first_nameobject

optional, string filter First name of the customer. **Supported operators :** is, is_not, starts_with, is_present **Example →** *first_name\[is\] = "John"*

isstring

is_notstring

starts_withstring

is_presentstring (boolean)

One oftruefalse

last_nameobject

optional, string filter Last name of the customer. **Supported operators :** is, is_not, starts_with, is_present **Example →** *last_name\[is\] = "Clint"*

isstring

is_notstring

starts_withstring

is_presentstring (boolean)

One oftruefalse

emailobject

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"*

isstring

is_notstring

starts_withstring

is_presentstring (boolean)

One oftruefalse

companyobject

optional, string filter Company name of the customer. **Supported operators :** is, is_not, starts_with, is_present **Example →** *company\[is_not\] = "Globex Corp"*

isstring

is_notstring

starts_withstring

is_presentstring (boolean)

One oftruefalse

phoneobject

optional, string filter Phone number of the customer. **Supported operators :** is, is_not, starts_with, is_present **Example →** *phone\[is_not\] = "(541) 754-3010"*

isstring

is_notstring

starts_withstring

is_presentstring (boolean)

One oftruefalse

auto_collectionobject

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"*

isstring

\* \`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.

One ofonoff

is_notstring

One ofonoff

instring

One ofonoff

not_instring

One ofonoff

taxabilityobject

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"*

isstring

* `taxable` - Computes tax for the customer based on the <a href="https://www.chargebee.com/docs/tax.html" target="_blank" rel="noopener noreferrer">site configuration</a>. 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` - <ul><li>Customer is exempted from tax. When using Chargebee’s native <a href="https://www.chargebee.com/docs/tax.html" target="_blank" rel="noopener noreferrer">Taxes</a> feature or when using the <a href="https://www.chargebee.com/docs/taxjar.html" target="_blank" rel="noopener noreferrer">TaxJar integration</a>, no other action is needed.</li><li>However, when using our <a href="https://www.chargebee.com/docs/avalara.html" target="_blank" rel="noopener noreferrer">Avalara integration</a>, optionally, specify <code>entity_code</code> or <code>exempt_number</code> attributes if you use Chargebee’s <a target="_blank" href="https://www.chargebee.com/docs/avalara.html#configuring-tax-exemption">AvaTax for Sales</a> or specify <code>exemption_details</code> attribute if you use <a href="https://www.chargebee.com/docs/avatax-for-communication.html" target="_blank" rel="noopener noreferrer">Chargebee’s AvaTax for Communications</a> integration. Tax may still be applied by Avalara for certain values of <code>entity_code</code>/<code>exempt_number</code>/<code>exemption_details</code> based on the state/region/province of the taxable address.</li></ul>

One oftaxableexempt

is_notstring

One oftaxableexempt

instring

One oftaxableexempt

not_instring

One oftaxableexempt

created_atobject

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"*

afterstring (unix-time)

beforestring (unix-time)

onstring (unix-time)

betweenstring

updated_atobject

<dfn class="text-muted">optional, timestamp(UTC) in seconds filter</dfn> To filter based on <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">updated_at</code>. 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 <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">sort_by</code> input parameter as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">updated_at</code> for a faster response. Supported operators : after, before, on, between Example → updated_at[after] = "1243545465"

afterstring (unix-time)

beforestring (unix-time)

onstring (unix-time)

betweenstring

offline_payment_methodobject

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"*

isstring

\* \`no_preference\` - No Preference \* \`cash\` - Cash \* \`check\` - Check \* \`bank_transfer\` - Bank Transfer \* \`ach_credit\` - ACH Credit \* \`sepa_credit\` - SEPA Credit \* \`boleto\` - Boleto \* \`us_automated_bank_transfer\` - US Automated Bank Transfer \* \`eu_automated_bank_transfer\` - EU Automated Bank Transfer \* \`uk_automated_bank_transfer\` - UK Automated Bank Transfer \* \`jp_automated_bank_transfer\` - JP Automated Bank Transfer \* \`mx_automated_bank_transfer\` - MX Automated Bank Transfer \* \`custom\` - Custom

One ofno_preferencecashcheckbank_transferach_creditsepa_creditboletous_automated_bank_transfereu_automated_bank_transferuk_automated_bank_transferjp_automated_bank_transfermx_automated_bank_transfercustom

is_notstring

instring

not_instring

auto_close_invoicesobject

optional, boolean filter Override for this customer, the [site-level setting](https://www.chargebee.com/docs/billing/2.0/usage-based-billing/metered_billing#configuring-metered-billing) 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](/docs/api/subscriptions/subscription-object#auto_close_invoices) which takes precedence. Possible values are : *true, false* **Supported operators :** is **Example →** *auto_close_invoices\[is\] = "true"*

isstring (boolean)

One oftruefalse

channelobject

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"*

isstring

\* \`web\` - The object was created (and is maintained) for the web channel directly in Chargebee via API or UI. \* \`app_store\` - The object data is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions) created in Apple App Store. Direct manipulation of this object via UI or API is disallowed. \* \`play_store\` - The object data is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions) created in Google Play Store. Direct manipulation of this object via UI or API is disallowed. In-App Subscriptions is currently in early access. Contact [eap@chargebee.com](mailto:eap@chargebee.com) for more information.

One ofwebapp_storeplay_store

is_notstring

One ofwebapp_storeplay_store

instring

One ofwebapp_storeplay_store

not_instring

One ofwebapp_storeplay_store

business_entity_idobject

optional, string filter The unique ID of the [business entity](/docs/api/advanced-features) of this subscription. This is always the same as the [business entity](/docs/api/subscriptions/subscription-object#customer_id) of the customer. **Supported operators :** is, is_not, starts_with **Example →** *business_entity_id\[is_not\] = "business_entity_id"*

isstring

sort_byobject

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.

ascstring

One ofcreated_atupdated_at

descstring

One ofcreated_atupdated_at

relationshipobject

Parameters for relationship

parent_idobject3 fields

Immediate parent with whom we will link our new customer(child)

payment_owner_idobject3 fields

Parent who is going to pay

invoice_owner_idobject3 fields

Parent who is going to handle invoices

Headers

chargebee-request-origin-devicestring

The device from which the customer has made the request

chargebee-request-origin-userstring (email)

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

chargebee-request-origin-user-encodedstring (email)

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-request-origin-ipstring

The IP address of the customer where the request originated

chargebee-business-entity-idstring

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.

Response

Returns 200 with an object. Read it in later steps with {{listCustomers.response.data.<field>}}.

listarray<object>

customerobjectrequired40 fields

<div class="api-description">Represents a customer, which can be an individual or organization that subscribes to your products or services. The customer resource associates with <a href="/docs/api/subscriptions/subscription-object">subscriptions</a>, <a href="/docs/api/cards/card-object">card information</a>, and billing addresses. The customer details include their ID, name, contact information, and any <a href="/docs/api/advanced-features">custom attributes</a> you'd like to associate with them.<div class="warning alert alert-warning">Breaking Change:<ul class="list-disc list-outside ml-6 my-4 space-y-2"> <li class="text-base leading-relaxed"><a href="https://www.chargebee.com/docs/2.0/sites-intro.html" target="_blank">Sites</a> created before March 1, 2014: <a href="/docs/api/cards/update-card-for-a-customer">updating the card</a> deletes the customer's <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">billing_address</code> and <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">vat_number</code> and replaces them with values from the request.</li> <li class="text-base leading-relaxed">Sites created on or after March 1, 2014: updating the card doesn't change the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">billing_address</code> and <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">vat_number</code>.</li> </ul></div></div>

cardobject28 fields

#### Deprecated The [Payment Sources API](/docs/api/payment_sources) , with its additional options and improvements, obsoletes the Cards APIs. [Learn more](/docs/api/getting-started) . The following table lists the Payment Sources API operations alongside the equivalent Card API operations: | API at Card resource | Use instead | |------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [Retrieve card for a customer](/docs/api/cards/retrieve-card-for-a-customer) | [Retrieve a payment source](/docs/api/payment_sources/retrieve-a-payment-source) | | [Update card for a customer](/docs/api/cards/update-card-for-a-customer) | * [Create using temporary token](/docs/api/payment_sources/create-using-gateway-temporary-token) * [Create using permanent token](/docs/api/payment_sources/create-using-permanent-token) * [Create a card payment source](/docs/api/payment_sources/create-a-card-payment-source) | | [Switch gateway](/docs/api/cards/switch-gateway) | [Switch gateway account](/docs/api/payment_sources/switch-gateway-account) | | [Copy card](/docs/api/cards/copy-card) | [Export payment source](/docs/api/payment_sources/export-payment-source) | | [Delete card for a customer](/docs/api/cards/delete-card-for-a-customer) | [Delete a payment source](/docs/api/payment_sources/delete-a-payment-source) |

next_offsetstring

This attribute is returned only if more resources are present. To fetch the next set of resources use this value for the input parameter <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">offset</code>.

json

{
  "list": null,
  "next_offset": null
}

Need more? See the Chargebee guide for connection setup and behaviour shared by every action.

Was this page helpful?