Skip to content

Repository files navigation

Paystack Subscription-Based Billing with NestJS

This repository contains the code for integrating Paystack subscription-based billing into a NestJS application.

Features

  • Customer Management: Create and retrieve customer information.
  • Subscription Plans: Create and manage subscription plans.
  • Webhook Integration: Handle Paystack events like charge.success and subscription.create.
  • Secure API: Ensure webhook authenticity with signature validation.

Note

This application is a simple implementation to demonstrate how to integrate Paystack for subscription-based billing.
It does not include:

  • Proper error handling
  • Input validation
  • Logging mechanisms
  • Unit or integration tests

Use it as a reference for building a more robust application.

Prerequisites

  • Node.js and npm installed
  • Paystack account setup (for test/live environments)
  • NestJS CLI installed globally (npm install -g @nestjs/cli)

Installation

  1. Clone the repository:
    git clone <repository-url>
  2. Navigate to the project directory:
    cd paystack-nestjs
  3. Install dependencies:
    npm install
  4. Create a .env file with your Paystack credentials:
    PAYSTACK_SECRET=your_paystack_secret_key
    PAYSTACK_BASE_URL=https://api.paystack.co
    PAYSTACK_SUCCESS_URL=https://example.com

Usage

  1. Start the development server:
    npm run start:dev
  2. Test webhook events using Webhook.site.

Contributing

Feel free to fork this repository, create a new branch, and submit a pull request. Contributions are always welcome!

License

This project is licensed under the MIT License.

About

No description, website, or topics provided.

Resources

Stars

2 stars

Watchers

1 watching

Forks

Releases

Packages

Used by

Contributors

Languages