Create data export

POST

/v1/data_exports/

Create a new data export and enqueue background processing.

Request Body ^required

DataExportCreate

Schema for creating a data export.

object

export_type

required

ExportType

Types of data that can be exported.

string

Allowed values: invoices customers subscriptions events fees credit_notes audit_logs

filters

Any of:

object

object

key

additional properties

any

null

null

Responses

201

Successful Response

DataExportResponse

Schema for data export response.

object

id

required

Id

string format: uuid

organization_id

required

Organization Id

string format: uuid

export_type

required

Export Type

string

status

required

Status

string

filters

Any of:

object

object

key

additional properties

any

null

null

file_path

Any of:

string

string

null

null

record_count

Any of:

integer

integer

null

null

progress

Any of:

integer

integer

null

null

error_message

Any of:

string

string

null

null

started_at

Any of:

string

string format: date-time

null

null

completed_at

Any of:

string

string format: date-time

null

null

created_at

required

Created At

string format: date-time

401

Unauthorized

422

Validation error