Sign in
Job

Find one Job

Retrieve a Job by its ID

get/jobs/{id}

Path parameters

idstring required

Response

OK

createdAtstring date-time required

The date and time when the entity was created.

updatedAtstring date-time nullable required

The date and time when the entity was last updated.

metadataobject nullable

Metadata used by merchants to store additional information about the entity.

idstring required

The unique identifier of the job

typestring required

Type of the job

namestring required

Name of the job

status'queued' | 'in_progress' | 'completed' | 'failed' required

Current status of the job

statusMessagestring nullable required

Optional status message providing additional details about the job

inputobject required

Input data for the job

progressnumber required

Progress of the job as a percentage, 0-100

Example response

{
  "createdAt": "2024-02-18T12:00:00Z",
  "updatedAt": "2024-02-21T12:15:00Z",
  "metadata": {
    "key1": "value1",
    "key2": "value2"
  },
  "type": "subscription-migrate-price",
  "name": "Migrate subscriptions from price_abc to price_xyz",
  "status": "failed",
  "statusMessage": "Failed due to timeout",
  "input": {
    "priceFrom": "price_abc",
    "priceTo": "price_xyz"
  },
  "progress": 75
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.