recurrbaserecurrbase docs
HomeSubscribeDashboardAPI

Quickstart

Get up and running with RecurrBase in 5 minutes.

Step 1: Get an API Key

  1. Sign in to the RecurrBase dashboard
  2. Navigate to API Keys
  3. Generate a new key with FULL scope
  4. Copy the key (you'll only see it once)

API keys are only shown once when created. Make sure to save them securely.

Step 2: Install SDK

npm install @recurrbase/sdk

Step 3: Initialize Client

import { RecurrBase } from "@recurrbase/sdk";

const recurrbase = new RecurrBase({
  apiKey: process.env.RECURRBASE_API_KEY!,
  baseUrl: "https://api.recurrbase.xyz",
});

Step 4: Check Subscription Status

const subscription = await recurrbase.subscriptions.status(walletAddress);

if (subscription.isActive) {
  console.log(`Active until ${subscription.expiresAt}`);
} else {
  console.log("No active subscription");
}

Step 5: Set Up Webhooks

Configure a webhook endpoint in the dashboard to receive subscription events.

See Webhooks Overview for details.

Next Steps