Cancel Subscription

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

Mutation

Mutation

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

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

{
  "data": {
    "cancelSubscription": {
      "subscriptionId": "sub-789",
      "status": "CANCELED",
      "cancellationDate": "2024-01-15T10:30:00Z",
      "endDate": "2024-02-15T00:00:00Z"
    }
  }
}

Parameters

input · SubscriptionCancellationInput · required

Input for canceling a subscription

Show properties

subscriptionRefId · String · required

The subscription reference ID to cancel

subscriptionCancellationTime · SubscriptionCancellationTime

When to cancel: IMMEDIATE, END_OF_BILLING_PERIOD, or SPECIFIC_DATE

endDate · DateTime

Specific cancellation date (required when subscriptionCancellationTime is SPECIFIC_DATE)

subscriptionCancellationAction · SubscriptionCancellationAction

Action on cancellation: DEFAULT or REVOKE_ENTITLEMENTS

prorate · Boolean

Whether to prorate credits on cancellation

environmentId · UUID

Environment ID

Cancellation Time Options

Value	Behavior
IMMEDIATE	Cancel immediately
END_OF_BILLING_PERIOD	Cancel at the end of the current billing period
SPECIFIC_DATE	Cancel on the date specified by endDate

Cancellation Action Options

Value	Behavior
DEFAULT	Default cancellation behavior
REVOKE_ENTITLEMENTS	Immediately revoke all entitlements upon cancellation

Return Type

Returns the canceled CustomerSubscription object with:

Field	Type	Description
subscriptionId	String	Subscription ID
status	SubscriptionStatus	New status (CANCELED)
cancellationDate	DateTime	When cancellation was requested
endDate	DateTime	When 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

Customer churn

Cancel when customer explicitly requests cancellation.

Payment failure

Cancel after failed payment recovery attempts.

Account deletion

Cancel as part of account deletion process.

Related Operations

• Update Subscription - Modify instead of cancel
• Archive Customer - Archive customer and cancel all