Export customers

Idempotency Supported

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

Sample Request

POST https://[site].chargebee.com/api/v2/exports/customers

export_type

optional, enumerated string, default=data

Determines the format of the data. Returns the export type based on the selected value.

Enum Values

data

Provides the full set of data for the customers in multiple .csv files.

import_friendly_data

Provides a .csv file whose columns match the customer schema. This file format can be readily imported through the UI by using Bulk Operations.

business_entity_id

optional, string

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] = "business_entity_id"

customer

Parameters for customer

pass parameters as customer[<param name>]

relationship

Parameters for relationship

pass parameters as relationship[<param name>]

Export object

Resource object representing export