railswitch

railswitch

Official TypeScript SDK for RailSwitch — recurring billing recovery for Nigeria.

Install

npm install railswitch

Quickstart

import { RailSwitch } from "railswitch";

const rs = new RailSwitch({ apiKey: "sk_test_..." });

// Create a plan
const plan = await rs.plans.create({
  name: "Pro Monthly",
  description: "Professional tier, billed monthly",
  amount: 15000,
  interval: "monthly",
  interval_count: 1,
});

// Create a customer
const customer = await rs.customers.create({
  name: "John Doe",
  email: "john@example.com",
});

// Subscribe a customer
const subscription = await rs.subscriptions.create({
  customer_id: customer.id,
  plan_id: plan.id,
  start_date: new Date().toISOString(),
});

// Preview a plan change
const preview = await rs.subscriptions.preview(subscription.id, "plan_pro_annual");
console.log(`Net charge: ₦${preview.net_amount}`);

// Pause / Resume / Cancel
await rs.subscriptions.pause(subscription.id);
await rs.subscriptions.resume(subscription.id);
await rs.subscriptions.cancel(subscription.id, "No longer needed");

// Payment methods
await rs.paymentMethods.create({
  customer_id: customer.id,
  type: "card",
  nomba_token: "tok_abc123",
  last4: "4242",
  brand: "visa",
});

// Webhooks
const endpoint = await rs.webhooks.createEndpoint("https://example.com/webhook");
await rs.webhooks.deleteEndpoint(endpoint.id);

API Reference

License

MIT