Skip to main content
GET
Get batch job detail

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

batch_job_id
string<MeteroidId>
required

Batch job ID

Example:

"bjob_7n42DGM5Tflk9n8mt7Fhc7"

Response

Batch job detail

created_at
string<date-time>
required
created_by
string<uuid>
required
failed_items
integer<int32>
required
failure_count
integer<int64>
required
has_error_csv
boolean
required
has_output
boolean
required
id
string<MeteroidId>
required
Example:

"bjob_7n42DGM5Tflk9n8mt7Fhc7"

job_type
enum<string>
required
Available options:
EVENT_CSV_IMPORT,
CUSTOMER_CSV_IMPORT,
SUBSCRIPTION_CSV_IMPORT,
SUBSCRIPTION_PLAN_MIGRATION,
TAX_REPORT_EXPORT
processed_items
integer<int32>
required
status
enum<string>
required
Available options:
PENDING,
CHUNKING,
PROCESSING,
COMPLETED,
COMPLETED_WITH_ERRORS,
FAILED,
CANCELLED
completed_at
string<date-time> | null
error_csv_url
string | null
input_file_name
string | null
input_file_url
string | null
output_url
string | null
total_items
integer<int32> | null