Stripe - Cancel Subscription

Description

This module allows you to cancel existing subscriptions. It can cancel immediately or schedule the cancellation for the end of the current billing period.

Configuration

Required Credentials

• Secret Key: Stripe secret key

Parameters

Parameter	Type	Required	Description
credentials_id	credential	Yes	Stripe credentials
subscription_id	string	Yes	Subscription ID (sub_xxx)
cancel_at_period_end	boolean	No	Cancel at end of period (default: true)
cancellation_reason	string	No	Cancellation reason
prorate	boolean	No	Prorate the remaining period
invoice_now	boolean	No	Generate invoice immediately

Output

Cancellation at end of period

{
  "success": true,
  "subscription": {...},
  "subscription_id": "sub_1MowQVLkdIwHu7ixeRlqHVzs",
  "status": "active",
  "cancel_at_period_end": true,
  "current_period_end": 1682288167,
  "message": "Suscripción sub_1MowQV... se cancelará al final del período"
}

Immediate cancellation

{
  "success": true,
  "subscription": {...},
  "subscription_id": "sub_1MowQVLkdIwHu7ixeRlqHVzs",
  "status": "canceled",
  "canceled_at": 1679609767,
  "message": "Suscripción sub_1MowQV... cancelada inmediatamente"
}

Usage Example

Cancel at end of period (recommended)

{
  "subscription_id": "sub_1MowQVLkdIwHu7ixeRlqHVzs",
  "cancel_at_period_end": true,
  "cancellation_reason": "Cliente solicitó cancelación"
}

Immediate cancellation

{
  "subscription_id": "sub_1MowQVLkdIwHu7ixeRlqHVzs",
  "cancel_at_period_end": false,
  "prorate": true
}

Immediate cancellation with invoice

{
  "subscription_id": "sub_1MowQVLkdIwHu7ixeRlqHVzs",
  "cancel_at_period_end": false,
  "invoice_now": true
}

API Used

• Endpoint: DELETE /v1/subscriptions/{id} or POST /v1/subscriptions/{id}
• Documentation: Stripe Cancel Subscription

Notes

• cancel_at_period_end: true maintains access until the end of the paid period
• Immediate cancellation may generate a prorated credit
• The cancellation reason is saved in cancellation_details
• A canceled subscription cannot be reactivated (create a new one)

Related Nodes

• StripeCreateSubscription - Create new subscriptions
• StripeGetSubscriptions - Get and search existing subscriptions
• StripeGetCustomers - Get subscription customer data