Cancel subscription - Automate.ax

Use stripe.cancelSubscription to cancel a Stripe subscription immediately.

Example

automations/stripe-cancel-subscription.automation.ts

import { automation, onDashboardRun } from "automate.ax"
import { stripe } from "automate.ax/stripe"

export default automation("Cancel subscription", () => {
  onDashboardRun({ title: "Cancel subscription" })

  stripe.cancelSubscription({
    subscriptionId: "sub_123",
    invoiceNow: true,
    prorate: true,
  })
})

Inputs

subscriptionId is required. Configure invoice and proration behavior as needed. To cancel at period end instead, update cancelAtPeriodEnd. idempotencyKey is optional. Inputs use camel case and accept compatible signals. Automate.ax converts provider fields to Stripe’s wire format. Metadata keys remain unchanged.

Output

Returns the canceled Stripe Subscription. Output fields use camel case. Nested Stripe decimal fields such as unitAmountDecimal are lossless strings.