Usage Guides

This section provides practical, step-by-step guides for implementing common payment workflows and managing resources with the PaymentKit SDK. Each guide focuses on a specific function, from creating one-time payments to setting up complex subscription and credit-based billing systems.

A typical payment process involves several resources working together. The following diagram illustrates a common flow from product definition to payment and subsequent actions:

To get started, select one of the guides below based on your integration needs.

Core Workflows#

• Checkout Sessions Learn to create secure, customizable payment pages for one-time purchases and subscriptions. This is the primary method for collecting payment details from your customers.
• Products & Prices A guide to defining the goods or services you sell and their corresponding pricing models, including one-time and recurring options.
• Subscriptions Manage the complete lifecycle of customer subscriptions, from creation and updates to pausing, resuming, and cancellation. This guide also covers how to report usage for metered plans.
• Credit Billing Implement a flexible, usage-based billing model. This guide covers creating meters to track usage, issuing credit grants to customers, and monitoring balances.
• Refunds Learn how to process full or partial refunds for completed payments and manage refund records.
• Webhooks Set up and manage webhook endpoints to receive real-time notifications about events in your PaymentKit account, such as checkout.session.completed or customer.subscription.created.

These guides are designed to be followed in sequence or read individually. For a new integration, we recommend starting with Products & Prices and then moving to Checkout Sessions. Once you are familiar with these guides, you can dive deeper into specific functions with the API Reference.