ChargebeeAPI

Exports

Export resource represents an export job and contains the status of the job and the download URL, if the job is successfully completed.

Export operations are asynchronous and will return "Export" resource in response . The export resource will contain the status of the export job (like in-process, completed...) . If the status is completed, it will contain the download url pointing to the zip/pdf containing the exported data.

Note: At any given point, only 5 export jobs can be processed. Beyond that, an error stating that the API request limit has been reached will be returned.

Sample ExportJSON

Exports attributes

id
required, string, max chars=50

A unique identifier to identify the export

operation_type
required, string, max chars=100

Describes the type of export

mime_type
required, enumerated string, default=zip

Describes the mime type of download file

Possible Enum Values
pdf

PDF

zip

ZIP

status
required, enumerated string, default=in_process

Current status of the export operation

Possible Enum Values
in_process

In Process

completed

Completed

failed

Failed

created_at
required, timestamp(UTC) in seconds

Export created time

download
optional, download

Returns the download_url for the export. The download URL is valid upto a specific date.