Next.js - Polar

Examples

Installation

Install the required Polar packages using the following command:

Terminal

npm install zod @polar-sh/nextjs

Terminal

yarn add zod @polar-sh/nextjs

Terminal

pmn add zod @polar-sh/nextjs

Terminal

bun add zod @polar-sh/nextjs

Checkout

Create a Checkout handler which takes care of redirections.

checkout/route.ts

import { Checkout } from "@polar-sh/nextjs";

export const GET = Checkout({
  accessToken: process.env.POLAR_ACCESS_TOKEN,
  successUrl: process.env.SUCCESS_URL,
  returnUrl: "https://myapp.com", // An optional URL which renders a back-button in the Checkout
  server: "sandbox", // Use sandbox if you're testing Polar - omit the parameter or pass 'production' otherwise
  theme: "dark", // Enforces the theme - System-preferred theme will be set if left omitted
});

Query Params

Pass query params to this route.

Customer Portal

Create a customer portal where your customer can view orders and subscriptions.

portal/route.ts

import { CustomerPortal } from "@polar-sh/nextjs";

export const GET = CustomerPortal({
  accessToken: process.env.POLAR_ACCESS_TOKEN,
  getCustomerId: (req: NextRequest) => "", // Function to resolve a Polar Customer ID
  returnUrl: "https://myapp.com", // An optional URL which renders a back-button in the Customer Portal
  server: "sandbox", // Use sandbox if you're testing Polar - omit the parameter or pass 'production' otherwise
});

Webhooks

A simple utility which resolves incoming webhook payloads by signing the webhook secret properly.

api/webhook/polar/route.ts

import { Webhooks } from "@polar-sh/nextjs";

export const POST = Webhooks({
  webhookSecret: process.env.POLAR_WEBHOOK_SECRET!,
  onPayload: async (payload) => {
    // Handle the payload
    // No need to return an acknowledge response
  },
});

Payload Handlers

The Webhook handler also supports granular handlers for easy integration.