The Firmhouse Logo [FH]
Developer Docs

cancelSubscription

Cancels a subscription or initiates cancellation when two-step cancellation is enabled on your project.

Arguments

ArgumentDescription
input (CancelSubscriptionInput!)
Parameters for CancelSubscription

CancelSubscriptionInput Arguments

ArgumentDescription
token (ID)
The token of the subscription to cancel, only needed if a project access token is used.
id (ID)
The ID of the subscription to cancel, only needed if a project access token is used.
skipTwoStepCancellation (Boolean)
If two-step cancellation is enabled it can be skipped
skipCancellationConfirmationEmail (Boolean)
Skip sending the standard cancellation confirmation email to the customer.
cancellationNotes (String)
Why did this customer decide to cancel?
skipContractTermsEnforcement (Boolean)
If a customer cannot be cancelled due to active commitments, this process can be skipped.

Return Fields

subscription (Subscription)