Suspend a company's account

post

https://api.gusto-demo.com/v1/companies/{company_uuid}/suspensions

Use this endpoint to suspend a company. After suspension, company will no longer be able to run payroll but will retain access to their information, such as retrieving employee info or retrieving past payrolls.

scope: company_suspensions:write

Path Params

company_uuid

string

required

The UUID of the company

Body Params

file_quarterly_forms

boolean

required

Should Gusto file quarterly tax forms on behalf of the company? The correct answer can depend on why the company is suspending their account, and how taxes are being reconciled.

file_yearly_forms

boolean

required

Should Gusto file yearly tax forms on behalf of the company? The correct answer can depend on why the company is suspending their account, and how taxes are being reconciled.

reconcile_tax_method

string

enum

required

How Gusto will handle taxes already collected.

Allowed:

comments

string

User-supplied comments describing why they are suspending their account. Required if the user is leaving for another provider and selects "other" instead of a defined provider.

reason

string

enum

required

Explanation for why the company is suspending their account.

FEIN or entity type changes require Customer Support

If a company is switching FEIN or changing their entity type, this change must be performed by Gusto Customer Support and cannot be performed via the API at this time.

Allowed:

leaving_for

string

enum

The competitor the company is switching to. Required if reason is 'switching_provider'.

Switching to Gusto requires Customer Support

If 'gusto_com' is selected, this change must be completed by Gusto Customer Support and cannot be performed via the API. This endpoint will return a 422 error in that case.

Headers

X-Gusto-API-Version

string

enum

Defaults to 2026-02-01

Determines the date-based API version associated with your API call. If none is provided, your application's minimum API version is used.

Allowed:

Responses

Language

Credentials

Bearer

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

FEIN or entity type changes require Customer Support

Switching to Gusto requires Customer Support

200Successful response

422Unprocessable Entity This may happen when the body of your request contains errors such as invalid_attribute_value, or the request fails due to an invalid_operation. See the Errors Categories guide for more details.