The API reference provides detailed documentation for every resource and method available in the PaymentKit Node.js SDK. Each resource has a dedicated page with comprehensive information on its methods, parameters, return values, and usage examples.
Browse the resources below to find the specific API you need to work with.
Core Resources
Checkout Sessions
Create and manage Checkout Sessions to handle payment flows for one-time purchases and subscriptions.
Customers
Create and manage Customer objects to store payment information and track subscriptions.
Payment Intents
Manage the lifecycle of a payment, from creation to confirmation and completion.
Payment Links
Create shareable links for products or prices that redirect to a checkout page.
Payment Methods
List and manage available payment methods for your customers.
Refunds
Programmatically create and manage refunds for completed payments.
Product & Pricing
Products
Define the goods or services you offer. Products are the foundation of your billing system.
Prices
Manage the pricing models for your products, including one-time and recurring options.
Payment Currencies
List supported currencies and manage configurations for credit currency recharges.
Subscriptions & Usage
Subscriptions
Create and manage subscriptions for recurring billing.
Subscription Items
Manage individual items within a subscription and report usage records for metered billing.
Credit-Based Billing
Meters
Create and manage meters to track customer usage for credit-based billing.
Meter Events
Report usage events to a meter, which will be used to deduct from a customer's credit balance.
Credit Grants
Issue credits to customers, either as a paid purchase or a promotional bonus.
Credit Transactions
View a customer's credit history, including grants, deductions, and expirations.