@flowglad/server v0.10.14

@flowglad/server

This package provides a server-side SDK for integrating with Flowglad.

Installation

npm install @flowglad/server
# or
yarn add @flowglad/server
# or
pnpm add @flowglad/server

Usage

import { FlowgladServer } from '@flowglad/server'

const flowgladServer = new FlowgladServer({
  // optional - reads from FLOWGLAD_SECRET_KEY
  apiKey: 'your-api-key',
  // optional
  baseURL: 'https://app.flowglad.com',
  getRequestingCustomer: async () => {
    // Return the current customer
    return {
      externalId: 'user-123',
      name: 'John Doe',
      email: 'john@example.com',
    }
  },
})

// Get the customer ID
const customerId = await flowgladServer.getRequestingCustomerId()

// Get the customer session
const session = await flowgladServer.getSession()

// Find or create a customer
const customer = await flowgladServer.findOrCreateCustomer()

// Get customer billing information
const billing = await flowgladServer.getBilling()

// Get the catalog
const catalog = await flowgladServer.getCatalog()

// Create a subscription
const subscription = await flowgladServer.createSubscription({
  planId: 'plan-123',
  quantity: 1,
})

// Cancel a subscription
const canceledSubscription = await flowgladServer.cancelSubscription({
  id: 'sub-123',
  cancellation: {
    reason: 'customer-requested',
  },
})

// Create a usage event
const usageEvent = await flowgladServer.createUsageEvent({
  featureId: 'feature-123',
  quantity: 1,
  usageDate: new Date().toISOString(),
})

// Create a checkout session
const checkoutSession = await flowgladServer.createCheckoutSession({
  type: 'subscription',
  priceId: 'price-123',
  successUrl: 'https://example.com/success',
  cancelUrl: 'https://example.com/cancel',
})

Integration Tests

This package includes integration tests that test the FlowgladServer against a local implementation of flowglad-next.

Prerequisites

• Node.js 18+
• pnpm
• Docker and Docker Compose

Running Integration Tests Locally

1. Start the flowglad-next server:

cd platform/flowglad-next
pnpm test:setup
pnpm dev

2. In a new terminal, run the integration tests:

cd packages/server
pnpm test:integration

Running Integration Tests in CI

The integration tests are automatically run in CI when changes are made to the server package or the flowglad-next package.

License

MIT