convex-billing

作者: get-convex

透過 @convex-dev/stripe 為 Convex 應用程式新增 Stripe 帳單/付款功能(checkout + webhook + gating)。

npx skills add https://github.com/get-convex/agent-skills --skill convex-billing

Add billing / payments

Wire Stripe to Convex using @convex-dev/stripe: a checkout action, an httpAction webhook registered by the component (signature-verified automatically), subscription state stored in the component's tables, and server-side gating via a query.

Workflow

  1. Install the component: npm install @convex-dev/stripe.
  2. Create convex/convex.config.ts:
    import { defineApp } from 'convex/server';
    import stripe from '@convex-dev/stripe/convex.config.js';
    const app = defineApp();
    app.use(stripe);
    export default app;
    
  3. Store Stripe keys in Convex env (use the env micro power): STRIPE_SECRET_KEY (sk_test_… / sk_live_…) and STRIPE_WEBHOOK_SECRET (whsec_…).
  4. Create convex/http.ts to register the webhook route (the component handles signature verification automatically):
    import { httpRouter } from 'convex/server';
    import { components } from './_generated/api';
    import { registerRoutes } from '@convex-dev/stripe';
    const http = httpRouter();
    registerRoutes(http, components.stripe, { webhookPath: '/stripe/webhook' });
    export default http;
    
  5. Create convex/billing.ts with a checkout action and a subscription-gate query:
    import { action, query } from './_generated/server';
    import { components } from './_generated/api';
    import { StripeSubscriptions } from '@convex-dev/stripe';
    import { v } from 'convex/values';
    const stripeClient = new StripeSubscriptions(components.stripe, {});
    export const createSubscriptionCheckout = action({
      args: { priceId: v.string() },
      returns: v.object({ sessionId: v.string(), url: v.union(v.string(), v.null()) }),
      handler: async (ctx, args) => {
        const identity = await ctx.auth.getUserIdentity();
        if (!identity) throw new Error('Not authenticated');
        const customer = await stripeClient.getOrCreateCustomer(ctx, { userId: identity.subject, email: identity.email, name: identity.name });
        return await stripeClient.createCheckoutSession(ctx, { priceId: args.priceId, customerId: customer.customerId, mode: 'subscription', successUrl: `${process.env.SITE_URL ?? 'http://localhost:3000'}/?success=true`, cancelUrl: `${process.env.SITE_URL ?? 'http://localhost:3000'}/?canceled=true`, subscriptionMetadata: { userId: identity.subject } });
      },
    });
    export const isSubscribed = query({
      args: {},
      returns: v.boolean(),
      handler: async (ctx) => {
        const identity = await ctx.auth.getUserIdentity();
        if (!identity) return false;
        const subscriptions = await ctx.runQuery(components.stripe.public.listSubscriptionsByUserId, { userId: identity.subject });
        return subscriptions.some((sub) => sub.status === 'active' || sub.status === 'trialing');
      },
    });
    
  6. Run npx convex dev --once — it will install the component and push the functions. Verify output shows ✔ Installed component stripe.
  7. In Stripe Dashboard → Webhooks: add endpoint https://<deployment>.convex.site/stripe/webhook, subscribe to checkout.session.completed, customer.subscription.*, invoice.*, payment_intent.*. Copy the signing secret as STRIPE_WEBHOOK_SECRET.

Rules

  • Use @convex-dev/stripe (npm: @convex-dev/stripe@^0.1.4) — it handles webhook signature verification internally via registerRoutes; do NOT write a manual constructEvent webhook.
  • Stripe keys live in Convex env (use the env micro power): STRIPE_SECRET_KEY and STRIPE_WEBHOOK_SECRET.
  • Gate on server-stored subscription state via isSubscribed query (reads component tables), not client claims.
  • convex/convex.config.ts must import from '@convex-dev/stripe/convex.config.js' (not .ts) — the .js extension is required by the Convex bundler.

來自 get-convex 的更多技能

convex-performance-audit
get-convex
審計Convex在讀取、訂閱、寫入競爭及函數限制方面的效能。適用於功能緩慢、洞察發現、OCC衝突或讀取放大等情況。
developmentdatabasedata-analysis
convex
get-convex
將一般 Convex 請求路由至正確的專案技能。當使用者詢問該使用哪個 Convex 技能,或給出未明確指定的 Convex 應用任務時使用。
developmentdatabase
convex-setup-auth
get-convex
設定 Convex 驗證、身份映射與存取控制。用於 Convex 應用中的登入、驗證提供者、使用者資料表、受保護函式或角色。
developmentdatabaseapi
convex-quickstart
get-convex
建立或將 Convex 加入應用程式。適用於新的 Convex 專案、npm create convex@latest、前端設定、環境變數,或首次執行 npx convex dev。
developmentdatabase
convex-migration-helper
get-convex
使用 widen-migrate-narrow 和 @convex-dev/migrations 規劃 Convex 架構與資料遷移。適用於破壞性架構變更、資料回填、資料表重塑或零停機部署。
developmentdatabase
convex-create-component
get-convex
構建可重複使用的 Convex 元件,包含獨立的資料表與面向應用程式的 API。適用於新元件、可重複使用的後端模組、整合或元件邊界工作。
developmentdatabase
convex-migrate
get-convex
使用 @convex-dev/migrations 在已部署的 Convex 應用程式上遷移 schema 並回填資料。
developmentdatabase
convex-optimize
get-convex
審計並優化現有的 Convex 應用程式:安全性、擴展性、升級與可觀測性。