Cancel Company

post

https://api.applicant-tracking.com/api/v1/companies/{company_id}/billing/cancellation

Cancels one of your companies, now or on a later date. Send now: true to cancel immediately, or cancel_on (YYYY-MM-DD, today or later) for the last day the company stays open; it closes at the end of that day. Scheduling again replaces the date, and DELETE takes a scheduled cancellation back. Canceling an already canceled company succeeds without changing anything. A canceled company can be reopened with POST billing/restoration. Users need the AccountManagement permission. Integration-partner keys are refused.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

company_id

string

required

The identifier of the associated company.

Body Params

cancel_on

date

The last day the company stays open, YYYY-MM-DD, today or later. Schedules the cancellation; cannot be combined with now. Private-label keys only.

now

boolean

true cancels the company immediately. Cannot be combined with cancel_on.

reason

string

enum

Why the company is leaving. Optional. Noted on the billing subscription, and kept with ways_to_improve and contactable as a cancellation survey when a signed-in user cancels.

Allowed:

ways_to_improve

string

Free-text feedback. Optional.

contactable

boolean

Whether the company may be contacted about its feedback. Optional.

Responses

204

The company was canceled, or its cancellation scheduled. Returns an empty payload.

401

The user does not have the AccountManagement permission.

403

Not authorized

404

The company is not one of yours.

500

Internal system error. Please contact support in the event that this occurs.