Pricing Templates
Log in Sign up
Integrations / Chargebee Product / ...

POST /exports/customers

This API triggers export of customer data. The exported zip file contains CSV files with customer-related data.

Servers

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-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-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
customer Object No

Parameters for customer
customer.taxability Object No

Specifies if the customer is liable for tax
customer.taxability.not_in String No
customer.taxability.in String No
customer.taxability.is_not String No

* `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"
customer.taxability.is String No

* `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"
customer.first_name Object No

First name of the customer
customer.first_name.starts_with String No
customer.first_name.is_not String No
customer.first_name.is String No
customer.first_name.is_present String No

Possible values:

  • "false"
  • "true"
customer.auto_close_invoices Object No

Override for this customer, the [site-level setting](https://www.chargebee.com/docs/2.0/metered_billing.html#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?prod_cat_ver=2#subscription_auto_close_invoices) which takes precedence.
customer.auto_close_invoices.is String No

Possible values:

  • "false"
  • "true"
customer.updated_at Object No

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.
customer.updated_at.on String No
customer.updated_at.after String No
customer.updated_at.between String No
customer.updated_at.before String No
customer.id Object No

Identifier of the customer.
customer.id.not_in String No
customer.id.starts_with String No
customer.id.in String No
customer.id.is_not String No
customer.id.is String No
customer.offline_payment_method Object No

The preferred offline payment method for the customer.
customer.offline_payment_method.not_in String No
customer.offline_payment_method.in String No
customer.offline_payment_method.is_not String No

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

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"
customer.offline_payment_method.is String No

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

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"
customer.email Object No

Email of the customer. Configured email notifications will be sent to this email.
customer.email.starts_with String No
customer.email.is_not String No
customer.email.is String No
customer.email.is_present String No

Possible values:

  • "false"
  • "true"
customer.channel Object No

The subscription channel this object originated from and is maintained in.
customer.channel.not_in String No
customer.channel.in String No
customer.channel.is_not String No

* `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) 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) 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 for more information.

Possible values:

  • "web"
  • "play_store"
  • "app_store"
customer.channel.is String No

* `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) 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) 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 for more information.

Possible values:

  • "web"
  • "play_store"
  • "app_store"
customer.last_name Object No

Last name of the customer
customer.last_name.starts_with String No
customer.last_name.is_not String No
customer.last_name.is String No
customer.last_name.is_present String No

Possible values:

  • "false"
  • "true"
customer.company Object No

Company name of the customer.
customer.company.starts_with String No
customer.company.is_not String No
customer.company.is String No
customer.company.is_present String No

Possible values:

  • "false"
  • "true"
customer.phone Object No

Phone number of the customer
customer.phone.starts_with String No
customer.phone.is_not String No
customer.phone.is String No
customer.phone.is_present String No

Possible values:

  • "false"
  • "true"
customer.auto_collection Object No

Whether payments needs to be collected automatically for this customer
customer.auto_collection.not_in String No
customer.auto_collection.in String No
customer.auto_collection.is_not String No

* `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"
customer.auto_collection.is String No

* `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"
customer.created_at Object No

Timestamp indicating when this customer resource is created.
customer.created_at.on String No
customer.created_at.after String No
customer.created_at.between String No
customer.created_at.before String No
business_entity_id Object No

optional, string filter The unique ID of the [business entity](/docs/api?prod_cat_ver=2#mbe) of this subscription. This is always the same as the [business entity](/docs/api/subscriptions?prod_cat_ver=2#subscription_customer_id) of the customer. **Supported operators :** is, is_not, starts_with **Example →** *business_entity_id\[is\] = "business_entity_id"*
business_entity_id.starts_with String No
business_entity_id.is_not String No
business_entity_id.is String No
relationship Object No

Parameters for relationship
relationship.parent_id Object No

Immediate parent with whom we will link our new customer(child)
relationship.parent_id.starts_with String No
relationship.parent_id.is_not String No
relationship.parent_id.is String No
relationship.invoice_owner_id Object No

Parent who is going to handle invoices
relationship.invoice_owner_id.starts_with String No
relationship.invoice_owner_id.is_not String No
relationship.invoice_owner_id.is String No
relationship.payment_owner_id Object No

Parent who is going to pay
relationship.payment_owner_id.starts_with String No
relationship.payment_owner_id.is_not String No
relationship.payment_owner_id.is String No
export_type String No

Determines the format of the data. Returns the export type based on the selected value. * data - Download your current data in CSV. * import_friendly_data - Download import friendly data in CSV. This CSV can be used to perform bulk operations.

Possible values:

  • "data"
  • "import_friendly_data"

Default value: "data"

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. 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.
  3. Click Test request to test run your request to the API and see the API's response.
All third party trademarks (including logos and icons) are the property of their respective owners, which do not sponsor, authorize, or endorse this website.
Pricing Templates Integrations Blog Contact Us Help
© 2025 SimWorkflow
Terms of Service Privacy Policy