> ## Documentation Index
> Fetch the complete documentation index at: https://docs.automate.ax/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> Automate.ax automations are TypeScript programs.
> Use Bun for installation and command examples.
> Use Automate.ax for the product name and automate.ax for the package, CLI, and domain.
> Treat documented public APIs as current; do not invent transitional or deprecated names.

# Update subscription

> Update items, billing behavior, trials, or cancellation settings on a Stripe subscription.

Use `stripe.updateSubscription` to update items, billing behavior, trials, or cancellation settings on a Stripe subscription.

## Example

```ts automations/stripe-update-subscription.automation.ts theme={null}
import { automation, onDashboardRun } from "automate.ax"
import { stripe } from "automate.ax/stripe"

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

  stripe.updateSubscription({
    subscriptionId: "sub_123",
    cancelAtPeriodEnd: true,
  })
})
```

## Inputs

`subscriptionId` is required. Review Stripe's proration and payment behavior when changing prices or quantities. `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 updated Stripe Subscription. Output fields use camel case. Nested Stripe decimal fields such as `unitAmountDecimal` are lossless strings.