Loading...
Loading...
Guide for mounting official @dodopayments/* checkout, portal, and verified-webhook route handlers in supported web frameworks; use domain skills for payment and lifecycle logic.
npx skill4agent add dodopayments/skills framework-adapters@dodopayments/*CheckoutCustomerPortalWebhooks| Adapter | Checkout export | Portal export | Handler shape |
|---|---|---|---|
| | | returns a request handler |
| | | returns |
| | | returns |
| | | returns |
| | | no import statement |
| | — | |
checkout-integrationwebhook-integrationcustomer-management| Framework | Package | Install |
|---|---|---|
| Next.js | | |
| Express | | |
| Fastify | | |
| Hono | | |
| Astro | | |
| Remix | | |
| SvelteKit | | |
| Nuxt | | |
| TanStack Start | | |
| Bun | | |
| Convex | | |
DODO_PAYMENTS_API_KEY=dodo_test_...
DODO_PAYMENTS_WEBHOOK_KEY=your-webhook-secret
DODO_PAYMENTS_ENVIRONMENT=test_mode
DODO_PAYMENTS_RETURN_URL=https://yourdomain.com/checkout/successNUXT_PRIVATE_BEARER_TOKEN=dodo_test_...
NUXT_PRIVATE_WEBHOOK_KEY=your-webhook-secret
NUXT_PRIVATE_ENVIRONMENT=test_mode
NUXT_PRIVATE_RETURNURL=https://yourdomain.com/checkout/success.envDODO_PAYMENTS_API_KEY=dodo_test_...
DODO_PAYMENTS_ENVIRONMENT=test_mode
DODO_PAYMENTS_WEBHOOK_SECRET=your-webhook-secretDODO_PAYMENTS_WEBHOOK_KEYDODO_PAYMENTS_WEBHOOK_SECRETenvironmentenvironmentPick<ClientOptions, "environment">"test_mode" | "live_mode"process.env.Xstring | undefined// lib/dodo-env.ts
export const dodoEnvironment =
process.env.DODO_PAYMENTS_ENVIRONMENT === "live_mode" ? "live_mode" : "test_mode";test_modedodoEnvironment@dodopayments/nextjsapp/api/checkout/route.tsapp/api/customer-portal/route.tsapp/api/webhook/route.ts// app/api/checkout/route.ts
import { Checkout } from "@dodopayments/nextjs";
export const GET = Checkout({
bearerToken: process.env.DODO_PAYMENTS_API_KEY,
returnUrl: process.env.DODO_PAYMENTS_RETURN_URL,
environment: dodoEnvironment,
type: "static",
});
export const POST = Checkout({
bearerToken: process.env.DODO_PAYMENTS_API_KEY,
returnUrl: process.env.DODO_PAYMENTS_RETURN_URL,
environment: dodoEnvironment,
type: "session",
});// app/api/customer-portal/route.ts
import { CustomerPortal } from "@dodopayments/nextjs";
export const GET = CustomerPortal({
bearerToken: process.env.DODO_PAYMENTS_API_KEY,
environment: dodoEnvironment,
});// app/api/webhook/route.ts
import { Webhooks } from "@dodopayments/nextjs";
export const POST = Webhooks({
webhookKey: process.env.DODO_PAYMENTS_WEBHOOK_KEY,
onPayload: async (payload) => {
console.log("Webhook received:", payload.type);
},
});@dodopayments/expresscheckoutHandlerimport { Checkout } from "@dodopayments/express"import express from "express";
import { checkoutHandler } from "@dodopayments/express";
import { dodoEnvironment } from "./lib/dodo-env";
const app = express();
app.get("/api/checkout", checkoutHandler({
bearerToken: process.env.DODO_PAYMENTS_API_KEY,
returnUrl: process.env.DODO_PAYMENTS_RETURN_URL,
environment: dodoEnvironment,
type: "static",
}));
app.post("/api/checkout", checkoutHandler({
bearerToken: process.env.DODO_PAYMENTS_API_KEY,
returnUrl: process.env.DODO_PAYMENTS_RETURN_URL,
environment: dodoEnvironment,
type: "session",
}));import { CustomerPortal } from "@dodopayments/express";
app.get("/api/customer-portal", CustomerPortal({
bearerToken: process.env.DODO_PAYMENTS_API_KEY,
environment: dodoEnvironment,
}));import { Webhooks } from "@dodopayments/express";
app.use(express.raw({ type: "application/json" }));
app.post("/api/webhook", Webhooks({
webhookKey: process.env.DODO_PAYMENTS_WEBHOOK_KEY,
onPayload: async (payload) => {
console.log("Webhook:", payload.type);
},
}));@dodopayments/fastifyCheckout(config)getHandlerpostHandlerimport Fastify from "fastify";
import { Checkout } from "@dodopayments/fastify";
import { dodoEnvironment } from "./lib/dodo-env";
const fastify = Fastify();
const staticCheckout = Checkout({
bearerToken: process.env.DODO_PAYMENTS_API_KEY,
returnUrl: process.env.DODO_PAYMENTS_RETURN_URL,
environment: dodoEnvironment,
type: "static",
});
const sessionCheckout = Checkout({
bearerToken: process.env.DODO_PAYMENTS_API_KEY,
returnUrl: process.env.DODO_PAYMENTS_RETURN_URL,
environment: dodoEnvironment,
type: "session",
});
fastify.get("/api/checkout", staticCheckout.getHandler);
fastify.post("/api/checkout", sessionCheckout.postHandler);import { Webhooks } from "@dodopayments/fastify";
fastify.addContentTypeParser(
"application/json",
{ parseAs: "string" },
(req, body, done) => done(null, body)
);
fastify.post("/api/webhook", Webhooks({
webhookKey: process.env.DODO_PAYMENTS_WEBHOOK_KEY,
onPayload: async (payload) => {
console.log("Webhook:", payload.type);
},
}));@dodopayments/honoimport { Hono } from "hono";
import { Checkout } from "@dodopayments/hono";
const app = new Hono();
app.get("/api/checkout", Checkout({
bearerToken: process.env.DODO_PAYMENTS_API_KEY,
returnUrl: process.env.DODO_PAYMENTS_RETURN_URL,
environment: dodoEnvironment,
type: "static",
}));
app.post("/api/checkout", Checkout({
bearerToken: process.env.DODO_PAYMENTS_API_KEY,
returnUrl: process.env.DODO_PAYMENTS_RETURN_URL,
environment: dodoEnvironment,
type: "session",
}));import { CustomerPortal } from "@dodopayments/hono";
app.get("/api/customer-portal", CustomerPortal({
bearerToken: process.env.DODO_PAYMENTS_API_KEY,
environment: dodoEnvironment,
}));import { Webhooks } from "@dodopayments/hono";
app.post("/api/webhook", Webhooks({
webhookKey: process.env.DODO_PAYMENTS_WEBHOOK_KEY,
onPayload: async (payload) => {
console.log("Webhook:", payload.type);
},
}));@dodopayments/astrosrc/pages/api/checkout.tssrc/pages/api/customer-portal.tssrc/pages/api/webhook.ts// src/pages/api/checkout.ts
import { Checkout } from "@dodopayments/astro";
export const prerender = false;
// Astro reads env from import.meta.env, which is typed as string - so it needs
// the same narrowing as process.env. Define this alongside the other helper in
// lib/dodo-env.ts if you use both.
const dodoEnvironment =
import.meta.env.DODO_PAYMENTS_ENVIRONMENT === "live_mode" ? "live_mode" : "test_mode";
export const GET = Checkout({
bearerToken: import.meta.env.DODO_PAYMENTS_API_KEY,
returnUrl: import.meta.env.DODO_PAYMENTS_RETURN_URL,
environment: dodoEnvironment,
type: "static",
});
export const POST = Checkout({
bearerToken: import.meta.env.DODO_PAYMENTS_API_KEY,
returnUrl: import.meta.env.DODO_PAYMENTS_RETURN_URL,
environment: dodoEnvironment,
type: "session",
});// src/pages/api/webhook.ts
import { Webhooks } from "@dodopayments/astro";
export const prerender = false;
export const POST = Webhooks({
webhookKey: import.meta.env.DODO_PAYMENTS_WEBHOOK_KEY,
onPayload: async (payload) => {
console.log("Webhook:", payload.type);
},
});@dodopayments/remix// app/routes/api.checkout.tsx
import { Checkout } from "@dodopayments/remix";
import type { LoaderFunctionArgs, ActionFunctionArgs } from "@remix-run/node";
const checkoutHandler = Checkout({
bearerToken: process.env.DODO_PAYMENTS_API_KEY,
returnUrl: process.env.DODO_PAYMENTS_RETURN_URL,
environment: dodoEnvironment,
type: "session",
});
export const loader = ({ request }: LoaderFunctionArgs) => checkoutHandler(request);
export const action = ({ request }: ActionFunctionArgs) => checkoutHandler(request);// app/routes/api.customer-portal.tsx
import { CustomerPortal } from "@dodopayments/remix";
import type { LoaderFunctionArgs } from "@remix-run/node";
const portalHandler = CustomerPortal({
bearerToken: process.env.DODO_PAYMENTS_API_KEY,
environment: dodoEnvironment,
});
export const loader = ({ request }: LoaderFunctionArgs) => portalHandler(request);// app/routes/api.webhook.tsx
import { Webhooks } from "@dodopayments/remix";
import type { ActionFunctionArgs } from "@remix-run/node";
export const action = ({ request }: ActionFunctionArgs) =>
Webhooks({
webhookKey: process.env.DODO_PAYMENTS_WEBHOOK_KEY,
onPayload: async (payload) => {
console.log("Webhook:", payload.type);
},
})(request);@dodopayments/sveltekitsrc/routes/api/checkout/+server.tssrc/routes/api/customer-portal/+server.tssrc/routes/api/webhook/+server.ts// src/routes/api/checkout/+server.ts
import { Checkout } from "@dodopayments/sveltekit";
import { DODO_PAYMENTS_API_KEY, DODO_PAYMENTS_RETURN_URL, DODO_PAYMENTS_ENVIRONMENT } from "$env/static/private";
const checkoutHandler = Checkout({
bearerToken: DODO_PAYMENTS_API_KEY,
returnUrl: DODO_PAYMENTS_RETURN_URL,
environment: DODO_PAYMENTS_ENVIRONMENT,
type: "session",
});
export const GET = checkoutHandler;
export const POST = checkoutHandler;// src/routes/api/webhook/+server.ts
import { Webhooks } from "@dodopayments/sveltekit";
import { DODO_PAYMENTS_WEBHOOK_KEY } from "$env/static/private";
export const POST = Webhooks({
webhookKey: DODO_PAYMENTS_WEBHOOK_KEY,
onPayload: async (payload) => {
console.log("Webhook:", payload.type);
},
});@dodopayments/nuxtnuxt.config.ts// nuxt.config.ts
export default defineNuxtConfig({
modules: ["@dodopayments/nuxt"],
runtimeConfig: {
private: {
bearerToken: process.env.NUXT_PRIVATE_BEARER_TOKEN,
webhookKey: process.env.NUXT_PRIVATE_WEBHOOK_KEY,
environment: process.env.NUXT_PRIVATE_ENVIRONMENT,
returnUrl: process.env.NUXT_PRIVATE_RETURNURL,
},
},
});addServerImportsDircheckoutHandlercustomerPortalHandlerWebhooksserver/@dodopayments/nuxt// server/routes/api/checkout.ts
// checkoutHandler and useRuntimeConfig are auto-imported by the module.
const config = useRuntimeConfig();
export default checkoutHandler({
bearerToken: config.private.bearerToken,
returnUrl: config.private.returnUrl,
environment: config.private.environment,
type: "session",
});// server/routes/api/webhook.ts
// Webhooks and useRuntimeConfig are auto-imported by the module.
const config = useRuntimeConfig();
export default Webhooks({
webhookKey: config.private.webhookKey,
onPayload: async (payload) => {
console.log("Webhook:", payload.type);
},
});@dodopayments/tanstackCheckout(config)(request: Request) => Promise<Response>export const GET = Checkout(config)// src/routes/api/checkout.ts
import { Checkout } from "@dodopayments/tanstack";
import { dodoEnvironment } from "./lib/dodo-env";
export const GET = Checkout({
bearerToken: process.env.DODO_PAYMENTS_API_KEY,
returnUrl: process.env.DODO_PAYMENTS_RETURN_URL,
environment: dodoEnvironment,
type: "static",
});
export const POST = Checkout({
bearerToken: process.env.DODO_PAYMENTS_API_KEY,
returnUrl: process.env.DODO_PAYMENTS_RETURN_URL,
environment: dodoEnvironment,
type: "session",
});createServerFileRoute@dodopayments/bunimport { Checkout, CustomerPortal } from "@dodopayments/bun";
const checkoutHandler = Checkout({
bearerToken: process.env.DODO_PAYMENTS_API_KEY,
returnUrl: process.env.DODO_PAYMENTS_RETURN_URL,
environment: dodoEnvironment,
type: "session",
});
const portalHandler = CustomerPortal({
bearerToken: process.env.DODO_PAYMENTS_API_KEY,
environment: dodoEnvironment,
});
Bun.serve({
port: 3000,
fetch(request) {
const url = new URL(request.url);
if (url.pathname === "/api/checkout") {
return checkoutHandler(request);
}
if (url.pathname === "/api/customer-portal" && request.method === "GET") {
return portalHandler(request);
}
return new Response("Not Found", { status: 404 });
},
});@dodopayments/convexconvex.config.ts// convex/convex.config.ts
import { defineApp } from "convex/server";
import dodopayments from "@dodopayments/convex/convex.config";
const app = defineApp();
app.use(dodopayments);
export default app;// convex/checkout.ts
import { mutation } from "./_generated/server";
import { components } from "./_generated/server";
export const createCheckoutSession = mutation({
args: { customerId: v.string() },
handler: async (ctx, args) => {
const dodo = components.dodopayments;
return dodo.checkout.createSession(ctx, {
customerId: args.customerId,
// ... checkout params
});
},
});export const POSTDODO_PAYMENTS_WEBHOOK_KEYDODO_PAYMENTS_WEBHOOK_SECRETexpress.raw()webhook-integrationDODO_PAYMENTS_API_KEYDODO_PAYMENTS_ENVIRONMENT@dodopayments/core