DocsAPI Reference

API Reference

Complete API reference for PayKit SDK.

PayKit provides a unified API that works across all payment providers. This reference covers the core resource types.

Types


Customer


Checkout


Subscription


Invoice


Webhook Events

PayKit supports the following webhook events across all providers:

  • $customerCreated - Triggered when a customer is created
  • $customerUpdated - Triggered when a customer is updated
  • $customerDeleted - Triggered when a customer is deleted
  • $subscriptionCreated - Triggered when a subscription is created
  • $subscriptionUpdated - Triggered when a subscription is updated
  • $subscriptionCancelled - Triggered when a subscription is cancelled
  • $checkoutCreated - Triggered when a checkout is created
  • $invoicePaid - Triggered when an invoice is paid