Cancel Company

Cancels the company now: send now: true. A company may cancel itself only when it is billed directly, which the offering reports as cancelable; a company billed by its private label is canceled by the private label. A company cannot schedule its own cancellation for a later date. Canceling an already canceled company succeeds without changing anything. Users need the AccountManagement permission. Company keys may call it; integration-partner keys are refused.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
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.

boolean

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

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:
string

Free-text feedback. Optional.

boolean

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

Responses
204

The company was canceled. Returns an empty payload.

401

The user does not have the AccountManagement permission.

403

Not authorized

404

The company may not cancel itself: it is billed by its private label, or the request names a cancel_on date instead of now.

500

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

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json