@isnolan/nestjs-subscription

Subscription Module for NestJS

SubscriptionModule is a comprehensive subscription handling module for NestJS applications, providing seamless integration with multiple subscription platforms such as Stripe, Google Pay, and Apple Pay. It facilitates the handling of subscription events via webhooks, offering a unified approach to verify and process payment notifications securely.

Features

• Easy integration with Stripe, Google Pay, and Apple Pay.
• Secure validation and processing of payment webhooks.
• Customizable event handlers for different payment events.
• Supports both synchronous and asynchronous configurations.

Getting Started

Install

PNPM

• Install the package along with the stripe peer dependency

`pnpm install --save @isnolan/nestjs-subscription`

Import

Asynchronous configuration

To use SubscriptionModule, import and add it to the imports array of your NestJS module, typically AppModule. Here's how you can do it:

Synchronous configuration

import { SubscriptionModule } from '@isnolan/nestjs-subscription';

@Module({
  imports: [
    SubscriptionModule.forRoot({
      stripe: {
        apiSecretKey: `${process.env.STRIPE_SECRET_KEY}`,
        webhookSecret: `${process.env.STRIPE_SECRET_WEBHOOK}`,
      },
      apple: {
        signingKey: `${process.env.APPLE_SIGNING_KEY}`,
        keyId: `${process.env.APPLE_KEY_ID}`,
        issuerId: `${process.env.APPLE_ISSUER_ID}`,
        bundleId: `${process.env.APPLE_BUNDLE_ID}`,
        environment: 'Sandbox',
      },
    }),
  ],
  providers: [AppService],
})
export class AppModule {}

Asynchronous configuration

SubscriptionModule also supports asynchronous configuration, which is useful when the configuration needs to be dynamically determined at runtime.

import { SubscriptionModule } from '@isnolan/nestjs-subscription';
import { ConfigService } from '@nestjs/config';

@Module({
  imports: [
    SubscriptionModule.forRootAsync({
      inject: [ConfigService],
      useFactory: async (config: ConfigService) => config.get('subscription'),
    }),
  ],
  providers: [AppService],
})
export class AppModule {}

Configure Webhooks

The webhooks url is

Appple

https://api.xxxx.com/v1/notify/apple

Google

https://api.xxxx.com/v1/notify/google

Stripe

https://api.xxxx.com/v1/notify/stripe

Follow the instructions from the Stripe Documentation for remaining integration steps such as testing your integration with the CLI before you go live and properly configuring the endpoint from the Stripe dashboard so that the correct events are sent to your NestJS app.

Subscription lifetcycle

Event

事件生命周期	Apple Pay	Google Pay	Stripe
订阅创建	subscription_created	SUBSCRIPTION_STATE_PENDING	customer.subscription.created
订阅付款	subscription_renewed	SUBSCRIPTION_RENEWED	customer.subscription.updated
订阅取消	subscription_canceled	SUBSCRIPTION_CANCELED	customer.subscription.deleted
订阅过期	subscription_expired	SUBSCRIPTION_EXPIRED	customer.subscription.expired
付款成功	payment_success	PAYMENT_SUCCESS	invoice.payment_succeeded
付款失败	payment_failed	PAYMENT_FAILED	invoice.payment_failed

State

State	Apple Pay	Google Pay	Stripe
PENDING	INITIAL_BUY	SUBSCRIPTION_STATE_PENDING	customer.subscription.created
Active	subscription_created	SUBSCRIPTION_STATE_ACTIVE	customer.subscription.created
Paused	subscription_created	SUBSCRIPTION_STATE_ON_HOLD	customer.subscription.created
Canceled	subscription_created	SUBSCRIPTION_STATE_CANCELED	customer.subscription.created
Expired	subscription_created	SUBSCRIPTION_STATE_EXPIRED	customer.subscription.created

Contribute

Contributions welcome! Read the contribution guidelines first.

License

MIT License