Skip to content

Server SDK

Install the core SDK:

Terminal window
npm install @guapocado/sdk

Create a server Guapocado client with a server key:

import { createGuapocadoClient } from "@guapocado/sdk";
const guap = createGuapocadoClient({
apiKey: process.env.GUAPOCADO_API_KEY!,
customerId: "org_123",
});

customerId can be whichever stable entity your app bills: user, organization, team, workspace, project, account, or a dedicated Guapocado customer ID.

await guap.has("advanced-analytics");
await guap.limit("seats");
await guap.limits.configure("seats", {
purchased: 3,
autoExpansionEnabled: false,
});
await guap.usage.balance("api-calls");
await guap.usage.consume("api-calls", 1);
await guap.usage.refund("api-calls", 1);
await guap.usage.configure("api-calls", {
overageEnabled: true,
});
const session = await guap.checkout.create({
planKey: "pro",
successUrl: "https://app.example.com/billing/success",
cancelUrl: "https://app.example.com/billing",
});
return Response.redirect(session.url);
await guap.has("advanced-analytics", {
customerId: "team_123",
});