Autumn Payments

Always consult docs.useautumn.com for code examples and latest API.

Autumn handles Stripe checkout, upgrades, downgrades, and cancellations automatically.

Quick Reference

Payment Flow

1. checkout - Returns Stripe URL (new) or preview data (returning customer)
2. attach - Confirms purchase when card already on file

Checkout Result

Product Scenarios

React Implementation

tsx
1import { useCustomer, usePricingTable } from "autumn-js/react";
2
3const { checkout, attach } = useCustomer();
4const { products } = usePricingTable();
5
6// Checkout flow
7const data = await checkout({ productId: "pro" });
8if (data.url) {
9  window.location.href = data.url;  // New customer
10} else {
11  // Show confirmation dialog, then:
12  await attach({ productId: "pro" });
13}
14
15// Cancel
16const { cancel } = useCustomer();
17await cancel({ productId: "pro" });
18// Or downgrade to free:
19await attach({ productId: "free" });

Backend Implementation

typescript
1import { Autumn } from "autumn-js";
2
3const autumn = new Autumn({ secretKey: process.env.AUTUMN_SECRET_KEY });
4
5// Checkout
6const { data } = await autumn.checkout({ customer_id, product_id: "pro" });
7if (data.url) return redirect(data.url);
8
9// Attach (after user confirms)
10await autumn.attach({ customer_id, product_id: "pro" });
11
12// Get products with scenarios
13const { data: productsData } = await autumn.products.list({ customer_id });

Prepaid Pricing

For seat-based or prepaid products, pass quantities:

typescript
1await autumn.checkout({
2  customer_id,
3  product_id: "credits_pack",
4  options: [{ feature_id: "credits", quantity: 500 }],
5});

Button Text Pattern

typescript
1function getButtonText(product: Product): string {
2  const { scenario, properties } = product;
3  if (properties?.has_trial) return "Start Trial";
4  if (scenario === "active") return "Current Plan";
5  
6  const text = { upgrade: "Upgrade", downgrade: "Downgrade", new: "Subscribe" };
7  return text[scenario] ?? "Enable";
8}

Common Gotchas

1. URL field - It's data.url, not data.checkout_url
2. Don't build custom logic - Use products.list for scenarios
3. Proration automatic - Autumn handles upgrade/downgrade proration
4. Cancel via free - Prefer attaching free plan over hard cancel
5. Success URL - Pass success_url to redirect after Stripe checkout

Resources

• Checkout Docs
• Attach Docs
• LLMs.txt