Sign in

v1

latestOpenAPI 3.1.02026-07-243113441.2 MB
Companies

Suspend a company's account

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

post/v1/companies/{company_uuid}/suspensions

Path parameters

company_uuidstring required

The UUID of the company

Headers

X-Gusto-API-Version'2026-06-15'

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

Request body

file_quarterly_formsboolean 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_formsboolean 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'pay_taxes' | 'refund_taxes' required

How Gusto will handle taxes already collected.

commentsstring

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'switching_provider' | 'shutting_down' | 'acquired' | 'no_more_employees' | 'changing_ein_or_entity_type' 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.

leaving_for'accountant' | 'adp' | 'adp_total_source' | 'bamboo_hr' | 'bank_or_financial_institution' | 'check' | 'deel' | 'gusto_com' | 'homebase' | 'insperity' | 'intuit_or_quickbooks' | 'justworks' | 'manual' | 'namely' | 'onpay' | 'other' | 'oyster' | 'patriot' | 'paychex' | 'paycom' | 'paylocity' | 'remote' | 'rippling' | 'square' | 'surepayroll' | 'trinet' | 'velocity_global' | 'zenefits'

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.

Response

Successful response

uuidstring

Unique identifier for this suspension.

company_uuidstring

Unique identifier for the company which is suspended.

effective_datestring

Date that the suspension took effect.

leaving_forstring nullable

Which competitor the company is joining instead. Only required if reason is 'switching_provider'.

reasonstring

Explanation for why the company's account was suspended.

reconcile_tax_method'pay_taxes' | 'refund_taxes'

How Gusto will handle taxes already collected.

file_quarterly_formsboolean

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_formsboolean

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.

commentsstring nullable

User-supplied comments describing why they are suspending their account.