API Reference

Welcome to the API Reference for the PaymentKit Node.js SDK. This section provides detailed documentation for every resource and method available. Each resource has its own dedicated page with comprehensive information on parameters, return values, and practical code examples to help you integrate PaymentKit into your application.

Resource Relationship Diagram#

The following diagram illustrates how the core resources in PaymentKit interact with each other. It shows the relationships between the core billing model, payment initiation flows, customer management, and the credit-based billing system.

API Resources#

Browse the available resources below to find detailed information about each module's methods and data structures.

Payments & Checkout#

Resource	Description
Checkout Sessions	API for creating and managing Checkout Session objects to handle payment flows.
Payment Intents	API for creating and managing Payment Intent objects to process charges.
Payment Links	API for creating and managing reusable Payment Link objects.
Payment Methods	API for listing and managing available Payment Method objects.
Refunds	API for creating and managing Refund objects.

Customer & Subscription Management#

Resource	Description
Customers	API for creating and managing Customer objects.
Subscriptions	API for creating and managing Subscription objects for recurring payments.
Subscription Items	API for managing Subscription Item objects and reporting usage records.

Products & Pricing#

Resource	Description
Products	API for creating and managing Product objects that represent your goods or services.
Prices	API for creating and managing Price objects associated with your products.
Payment Currencies	API for listing supported currencies and managing credit currency recharge configurations.

Credit-Based Billing#

Resource	Description
Meters	API for creating and managing Meter objects to track usage for credit-based billing.
Meter Events	API for reporting usage events to a meter.
Credit Grants	API for creating and managing Credit Grant objects to issue credits to customers.
Credit Transactions	API for listing and retrieving Credit Transaction objects to view credit history.

Configuration & Webhooks#

Resource	Description
Webhook Endpoints	API for creating and managing Webhook Endpoint objects to receive events.
Settings	API for managing various settings within the PaymentKit.

Now that you have an overview of the available API resources, you can dive into the specifics of each one. If you are looking for practical implementation guides, please refer to the Core Concepts section.