Skip to main content

companyDeactivate

Deactivates a company: cancels its billing subscription and marks it inactive.

Business Rules​

  • A Stripe subscription is canceled immediately, without proration or a final invoice. Canceling revokes every subscription entitlement.
  • A subscription that is not linked to Stripe is marked canceled.
  • The company's account status becomes inactive.
  • Running it again skips whatever is already canceled or inactive.
  • Reactivating the company does not create a new subscription.

Error Scenarios​

  • **E0004**: when the company does not exist, or Stripe refuses the cancellation. Nothing in EC changes when Stripe refuses.

Permissions Required​

  • System admin.
companyDeactivate(
input: CompanyDeactivateInput!
): Party!

Arguments​

companyDeactivate.input ● CompanyDeactivateInput! non-null input common​

Parameters for CompanyDeactivate

Type​

Party object common​