API Reference

The PaymentKit Node.js SDK is organized around resources, each accessible as a property on the main payment client object. This API reference provides a comprehensive guide to all available resources, detailing their methods, parameters, and the data structures they return. Each resource section includes practical code examples to help you get started quickly.

For information on how to install and initialize the SDK, please see the Get Started guide.

SDK Resource Map#

The following diagram illustrates the structure of the SDK and the relationships between the core resources.

Resources#

Below is a list of all available API resources. Select a resource to view its detailed documentation, including available methods, parameters, and examples.

Resource	Description
Customers	API for managing customer records, including retrieval, updates, and listings.
Products	API for creating, retrieving, updating, and listing products.
Prices	API for managing pricing models associated with products, including creation, retrieval, and inventory updates.
Payment Intents	API for handling payment lifecycle, including creating payments, confirming, and refunding.
Payment Currencies	API for managing supported payment currencies.
Payment Methods	API for managing payment methods configuration and details.
Payment Links	API for creating and managing shareable payment links.
Checkout Sessions	API for managing checkout sessions, which orchestrate the payment flow for customers.
Subscriptions	API for managing customer subscriptions, including status, cancellation, and recovery.
Subscription Items	API for managing individual items within a subscription, including usage reporting.
Webhooks	API for configuring and managing webhook endpoints to receive event notifications.
Refunds	API for initiating and tracking refunds for payments.
Settings	API for managing various application-wide settings such as notifications.
Meters	API for creating and managing meters to track usage events for credit-based billing.
Meter Events	API for reporting usage events and retrieving usage statistics.
Credit Grants	API for issuing and managing credit grants to customers.
Credit Transactions	API for listing and summarizing credit transaction history for customers.

This reference provides the foundational details for each SDK resource. For workflow-oriented examples, such as processing a one-time payment or setting up a subscription, please refer to our Usage Guides.