API Reference

One-time checkout lifecycle hooks.

Create a Paystack customer automatically when a user signs up.

Skip persisting one-time payment records to the database (useful for tests).

Skip persisting webhook payloads to the database (useful for tests).

Customize Paystack customer fields before creation.

Called after a Paystack customer is created for a user.

Called for every verified Paystack webhook event.

The Paystack client to use for authentication.

The schema for the Paystack plugin.

Subscription billing configuration and lifecycle hooks.

Enable subscription billing.

Fires when a subscription is cancelled (including at period end).

Fires after the first successful payment completes a subscription checkout.

Fires when Paystack sends subscription.create.

Fires when a subscription is permanently deleted/disabled.

Fires on subscription status changes from webhooks or API sync.

Subscription plans exposed for checkout. Pass a static array of SubscriptionPlan definitions, or an async function that returns plans at runtime (for dynamic pricing or entitlements).

Each SubscriptionPlan is either auto-created or pre-created:

• Auto-created — provide name, amount, currency, and interval. The plugin creates or reuses matching Paystack plans when a customer subscribes. Optionally set annualDiscountedAmount for a discounted annual billing variant.
• Pre-created — provide name and planCode to reference an existing Paystack plan. Optionally set annualDiscountedPlanCode for annual billing. Do not include billing fields (amount, currency, interval) when using planCode.

Fires after a successful one-time checkout payment (charge.success without subscription).