ChargebeeAPI

Usage files

Represents a file containing usage events that has been uploaded for processing.

Usage files attributes

id
required, string, max chars=36

A unique identifier for the usage file.

name
required, string, max chars=150
mime_type
required, string, max chars=100
error_code
optional, string, max chars=50
error_reason
optional, string, max chars=500
status
optional, enumerated string, default=queued

Current status of the usage file.

Possible Enum Values
queued

The file is queued for processing.

imported

Data from the file has been imported.

processing

The file is currently being processed.

processed

File processing is completed.

failed

The file failed to process.

total_records_count
optional, long

Total number of records in the file.

processed_records_count
optional, long

Number of records that were successfully processed.

failed_records_count
optional, long

Number of records that failed validation or import.

file_size_in_bytes
optional, long

The size of the file in bytes.

processing_started_at
optional, timestamp(UTC) in seconds

Timestamp when the file processing began.

processing_completed_at
optional, timestamp(UTC) in seconds

Timestamp when the file processing was completed.

uploaded_by
optional, string, max chars=100

Identifier of the user or system that uploaded the file.

uploaded_at
optional, timestamp(UTC) in seconds

Timestamp when the file was uploaded.

error_file_path
optional, string, max chars=2000

Amazon S3 path in your bucket where the error file containing error codes is uploaded.

error_file_url
optional, string, max chars=2000

Pre-signed URL for the error_file containing error_codes. The link is valid for 60 minutes.

upload_details
optional, upload_detail

Contains details of the file upload.