Skip to content
/
Update a Subscription

Update a Subscription

Request

Updates a Subscription. Specify only those parameters you wish to change.

Security
basic_auth
Path
idstringrequired

ID of the Subscription.

Bodyapplication/jsonrequired
packagestring

Package to run for the Report.

candidate_idstring

ID of the candidate being screened.

start_datestring, (date)

Start date for the subscription. This is the date on which the subscription will begin, and the first time the report will be run.

interval_countinteger

The number of intervals between each recurrent background check.

interval_unitstring

Interval at which the subscription will repeat.

Enum:"day""week""month""year"
nodestring

custom_id of the associated node.

work_locationsArray of objects(WorkLocation)

Array of locations described using country, state, and city. When country is not specified defaults to US. State is required for US candidates. Country is required for non-US candidates.

curl -i -X POST \
  -u '<username>:<password>' \
  'https://docs.checkr.com/_mock/apis/openapi/subscriptions/{id}' \
  -H 'Content-Type: application/json' \
  -d '{
    "package": "string",
    "candidate_id": "string",
    "start_date": "2019-08-24",
    "interval_count": 0,
    "interval_unit": "day",
    "node": "string",
    "work_locations": [
      {
        "country": "US",
        "state": "CA",
        "city": "San Francisco"
      }
    ]
  }'

Responses

Subscription was successfully created

Bodyapplication/json
idstring(ResourceId)read-only

ID of the resource.

Example:"e44aa283528e6fde7d542194"
objectstringread-only
Value:"subscription"
uristring(ResourceURI)read-only

URI of the Subscription.

Example:"/v1/subscriptions/e44aa283528e6fde7d542194"
statusstring

Status of the Subscription.

Enum:"active""inactive"
Example:"active"
created_atstring, (date-time)

Time at which the Subscription was created.

Example:"2014-01-18T12:34:00Z"
canceled_atstring or null, (date-time)

Time at which the Subscription was canceled.

Example:null
packagestring

Package to run for the Subscription.

Example:"driver_pro"
interval_countinteger

The number of intervals between each recurrent background check.

Example:1
interval_unitstring

Interval at which the Subscription will repeat.

Enum:"day""week""month""year"
Example:"month"
start_datestring, (date)

Start date for the Subscription. This is the date on which the Subscription will begin, and the first time the report will be run.

Example:"2014-06-10"
next_occurrence_datestring, (date)

The next date on which the Subscription will be run. This date is determined based on the start_date, interval_unit, interval_count, and the last date the subscription was run.

Example:"2014-07-10"
candidate_idstring

ID of the candidate screened.

Example:"4722c07dd9a10c3985ae432a"
nodestring

Node to be used when generating a report for this Subscription.

Example:"zpy8orej4r614ize"
work_locationsArray of objects(WorkLocation)

Array of work locations to be used when generating a report for this Subscription.

Response
{
  "id": "e44aa283528e6fde7d542194",
  "object": "subscription",
  "uri": "/v1/subscriptions/e44aa283528e6fde7d542194",
  "status": "active",
  "created_at": "2014-01-18T12:34:00Z",
  "canceled_at": null,
  "package": "driver_pro",
  "interval_count": 1,
  "interval_unit": "month",
  "start_date": "2014-06-10",
  "next_occurrence_date": "2014-07-10",
  "candidate_id": "4722c07dd9a10c3985ae432a",
  "node": "zpy8orej4r614ize",
  "work_locations": [
    { … }
  ]
}
© Checkr, Inc.