Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.stigg.io/llms.txt

Use this file to discover all available pages before exploring further.

Cancels an active subscription, either immediately or at the end of the billing period.

​
Mutation

mutation CancelSubscription($input: SubscriptionCancellationInput!) {
  cancelSubscription(input: $input) {
    subscriptionId
    status
    cancellationDate
    endDate
  }
}

​
Parameters

​
input
SubscriptionCancellationInput
required
Input for canceling a subscription

​
Cancellation Time Options

ValueBehavior
IMMEDIATECancel immediately
END_OF_BILLING_PERIODCancel at the end of the current billing period
SPECIFIC_DATECancel on the date specified by endDate

​
Cancellation Action Options

ValueBehavior
DEFAULTDefault cancellation behavior
REVOKE_ENTITLEMENTSImmediately revoke all entitlements upon cancellation

​
Return Type

Returns the canceled CustomerSubscription object with:
FieldTypeDescription
subscriptionIdStringSubscription ID
statusSubscriptionStatusNew status (CANCELED)
cancellationDateDateTimeWhen cancellation was requested
endDateDateTimeWhen subscription ends

​
Examples

​
Immediate Cancellation

{
  "input": {
    "subscriptionRefId": "sub-789",
    "subscriptionCancellationTime": "IMMEDIATE",
    "subscriptionCancellationAction": "REVOKE_ENTITLEMENTS"
  }
}

​
Cancel at Period End

{
  "input": {
    "subscriptionRefId": "sub-789",
    "subscriptionCancellationTime": "END_OF_BILLING_PERIOD"
  }
}

​
Common Use Cases

Cancel when customer explicitly requests cancellation.
Cancel after failed payment recovery attempts.
Cancel as part of account deletion process.