Overview


The PaymentKit Node.js SDK provides a convenient wrapper around the PaymentKit REST API, enabling you to build powerful and flexible payment experiences directly within your Node.js applications. Whether you're handling one-time purchases, managing recurring subscriptions, or implementing sophisticated credit-based billing models, this SDK simplifies the integration process with a clean, modern, and fully-typed interface.

It is an isomorphic SDK that can be used in both Node.js environments and modern browsers.

Key Features#

Comprehensive Payment Models

Easily implement one-time payments with Checkout Sessions or manage recurring revenue with our robust Subscriptions API.

Flexible Product Catalog

Create and manage your products and their pricing structures, including support for multiple currencies and recurring intervals.

Credit-Based Billing

Build usage-based products with our advanced metering system. Track usage, grant credits to customers, and automatically deduct credits as services are consumed.

Full Customer Management

Create, retrieve, update, and manage your customer records, providing a seamless experience for your users.

Real-time Event Handling

Use Webhooks to receive and react to asynchronous events from the PaymentKit API, such as completed payments or subscription updates.

Developer-First Experience

Built with TypeScript, the SDK offers full type safety and autocompletion, helping you catch errors early and build with confidence.

How It Works#

The SDK acts as an intermediary between your application and the PaymentKit API. You interact with simple JavaScript methods, and the SDK handles the underlying HTTP requests, authentication, and error handling.


Next Steps#

Ready to integrate? Our Getting Started guide will walk you through installation, configuration, and your first API call in minutes.